Header file for PDF Annotation module of Foxit PDF SDK. More...
Go to the source code of this file.
Classes | |
| struct | FSPDF_ICONPROVIDER |
| Structure for the provider of alternate icons. More... | |
Functions | |
| FS_RESULT | FSPDF_Annot_Add (FSCRT_PAGE page, const FSCRT_RECTF *rect, const FSCRT_BSTR *annotType, const FSCRT_BSTR *filter, FS_INT32 index, FSCRT_ANNOT *annot) |
| Add an annotation with a specific index, by specific filter. More... | |
| FS_RESULT | FSPDF_Annot_Remove (FSCRT_ANNOT annot) |
| Remove an annotation from page. More... | |
| FS_RESULT | FSPDF_Annot_Move (FSCRT_ANNOT annot, const FSCRT_RECTF *newRect) |
| Move an annotation to a new position specified by a rectangle. More... | |
| FS_RESULT | FSPDF_Annot_SetFlags (FSCRT_ANNOT annot, FS_DWORD flags) |
| Set flags of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetName (FSCRT_ANNOT annot, const FSCRT_BSTR *name) |
| Set name of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetSubject (FSCRT_ANNOT annot, const FSCRT_BSTR *subject) |
| Set subject of a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetTitle (FSCRT_ANNOT annot, const FSCRT_BSTR *title) |
| Set title of a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetContents (FSCRT_ANNOT annot, const FSCRT_BSTR *contents) |
| Set contents of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetIconName (FSCRT_ANNOT annot, const FSCRT_BSTR *iconName) |
| Set icon name of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetBorder (FSCRT_ANNOT annot, const FSPDF_ANNOTBORDER *border) |
| Set border of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetColor (FSCRT_ANNOT annot, FS_BOOL isFillColor, FS_ARGB color) |
| Set filling or bordering color of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetOpacity (FSCRT_ANNOT annot, FS_FLOAT opacity) |
| Set opacity of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetAlignment (FSCRT_ANNOT annot, FS_INT32 alignment) |
| Set alignment of a free text annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetCreationDateTime (FSCRT_ANNOT annot, const FSCRT_DATETIMEZONE *dt) |
| Set creation time of a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetModifiedDateTime (FSCRT_ANNOT annot, const FSCRT_DATETIMEZONE *dt) |
| Set modification time of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetIntent (FSCRT_ANNOT annot, const FSCRT_BSTR *intent) |
| Set intent of a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetPopup (FSCRT_ANNOT annot, FSCRT_ANNOT popupAnnot) |
| Set a pop-up annotation to a specific markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetOpenStatus (FSCRT_ANNOT annot, FS_BOOL status) |
| Set open status of a text or pop-up annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetHighlightingMode (FSCRT_ANNOT annot, FS_INT32 hlMode) |
| Set highlighting mode of a link or widget annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetQuadPoints (FSCRT_ANNOT annot, FSCRT_QUADPOINTSF *quadPoints, FS_INT32 count) |
| Set quadrilaterals points of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetCalloutLinePoints (FSCRT_ANNOT annot, FS_FLOAT x1, FS_FLOAT y1, FS_FLOAT x2, FS_FLOAT y2, FS_FLOAT x3, FS_FLOAT y3) |
| Set callout line points of a free text annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetInnerRectMargin (FSCRT_ANNOT annot, FS_FLOAT left, FS_FLOAT top, FS_FLOAT right, FS_FLOAT bottom) |
| Set the margin between inner rectangle and rectangle of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetLineEndingStyles (FSCRT_ANNOT annot, const FSCRT_BSTR *startingStyle, const FSCRT_BSTR *endingStyle) |
| Set line ending styles of an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetLinePosition (FSCRT_ANNOT annot, FS_FLOAT x1, FS_FLOAT y1, FS_FLOAT x2, FS_FLOAT y2) |
| Set line position of a line annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetLeaderLineLength (FSCRT_ANNOT annot, FS_FLOAT length) |
| Set leader line length of a line annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetLeaderLineExtension (FSCRT_ANNOT annot, FS_FLOAT extLength) |
| Set leader line extension of a line annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetLeaderLineOffset (FSCRT_ANNOT annot, FS_FLOAT offset) |
| Set leader line offset of a line annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetCaptionContents (FSCRT_ANNOT annot, FS_BOOL hasCap) |
| Set flag which decides whether to set a caption to the annotation or not. More... | |
| FS_RESULT | FSPDF_Annot_SetCaptionPosition (FSCRT_ANNOT annot, const FSCRT_BSTR *captionPos) |
| Set caption position of a line annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetCaptionOffset (FSCRT_ANNOT annot, FS_FLOAT offsetx, FS_FLOAT offsety) |
| Set caption offset of a line annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetVertices (FSCRT_ANNOT annot, FS_FLOAT *vertices, FS_INT32 count) |
| Set vertices of a polygon or polyline annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetSymbol (FSCRT_ANNOT annot, const FSCRT_BSTR *symbol) |
| Set symbol of a caret annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetInkList (FSCRT_ANNOT annot, FSCRT_PATHDATA pathData) |
| Set ink list data of an ink annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetAttachment (FSCRT_ANNOT annot, FSPDF_ATTACHMENT attachment) |
| Set attachment of a file attachment annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetDefaultAppearance (FSCRT_ANNOT annot, const FSPDF_DEFAULTAPPEARANCE *defAppearance) |
| Set default appearance of a free text annotation, which can be used in formatting the text. More... | |
| FS_RESULT | FSPDF_Annot_SetIconFit (FSCRT_ANNOT annot, const FSPDF_ANNOTICONFIT *iconFit) |
| Set icon fit of a widget annotation. More... | |
| FS_RESULT | FSPDF_Annot_RemoveMKEntry (FSCRT_ANNOT annot, FS_INT32 mkEntry) |
| Remove a specified entry in MK dictionary. More... | |
| FS_RESULT | FSPDF_Annot_SetMKRotation (FSCRT_ANNOT annot, FS_INT32 degree) |
| Set rotation in MK dictionary. More... | |
| FS_RESULT | FSPDF_Annot_SetMKColor (FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_ARGB color) |
| Set color of specific type in MK dictionary. More... | |
| FS_RESULT | FSPDF_Annot_SetMKCaption (FSCRT_ANNOT annot, FS_INT32 mkEntry, const FSCRT_BSTR *caption) |
| Set caption of a specific type in MK dictionary. More... | |
| FS_RESULT | FSPDF_Annot_SetMKIconBitmap (FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BITMAP bitmap) |
| Set a bitmap to a specific icon entry in MK dictionary. More... | |
| FS_RESULT | FSPDF_Annot_SetMKIconImage (FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_IMAGE image) |
| Set an image to a specific icon entry in MK dictionary. More... | |
| FS_RESULT | FSPDF_Annot_SetIconProvider (FSPDF_ICONPROVIDER *iconProvider) |
| Set icon provider to SDK management. More... | |
| FS_RESULT | FSPDF_Annot_SetStamp (FSCRT_ANNOT annot, FSCRT_IMAGE image, FS_INT32 compress) |
| Set image to stamp annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetStampWithBitmap (FSCRT_ANNOT annot, FSCRT_BITMAP bitmap) |
| Set bitmap to stamp annotation. More... | |
| FS_RESULT | FSPDF_Annot_AddState (FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 state, FSCRT_ANNOT *stateAnnot) |
| Add a specific state to a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetState (FSCRT_ANNOT stateAnnot, FS_INT32 stateModel, FS_INT32 state) |
| Set state model and state out of a state annotation. More... | |
| FS_RESULT | FSPDF_Annot_RemoveAllStates (FSCRT_ANNOT annot) |
| Remove all the state annotations associated with an annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetGroup (FSCRT_ANNOT *annots, FS_INT32 count, FS_INT32 headerIndex) |
| Group all the input annotations. More... | |
| FS_RESULT | FSPDF_Annot_Ungroup (FSCRT_ANNOT annot) |
| Ungroup an annotation from the group it belongs to. More... | |
| FS_RESULT | FSPDF_Annot_InsertReply (FSCRT_ANNOT annot, FS_INT32 index, FSCRT_ANNOT *replyAnnot) |
| Insert a new empty reply with a specified index to a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_RemoveReply (FSCRT_ANNOT annot, FS_INT32 index) |
| Remove a reply with specified index to a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_RemoveAllReplies (FSCRT_ANNOT annot) |
| Remove all the replies of a markup annotation. More... | |
| FS_RESULT | FSPDF_Annot_SetAction (FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA *actionData) |
| Set action data of specified index associated with an annotation. More... | |
| FS_RESULT | FSPDF_Annot_InsertAction (FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA *actionData) |
| Insert an action of specified index associated with an annotation. More... | |
| FS_RESULT | FSPDF_Annot_RemoveAction (FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index) |
| Remove an action of specified index associated with an annotation. More... | |
| FS_RESULT | FSPDF_Annot_RemoveAllActions (FSCRT_ANNOT annot, FS_INT32 trigger) |
| Remove all the actions associated with an annotation. More... | |
| FS_RESULT | FSPDF_Annot_ResetAppearance (FSCRT_ANNOT annot) |
| Reset(regenerate) appearance of an annotation. More... | |
| FS_RESULT | FSPDF_Archive_SerializeAnnot (FSCRT_ARCHIVE archive, FSCRT_PAGE page, FSCRT_ANNOT annot) |
| Serialize the annotation. More... | |
| FS_RESULT | FSPDF_Archive_DeserializeAnnot (FSCRT_ARCHIVE archive, FSCRT_PAGE page, FSCRT_ANNOT *annot) |
| De-serialize the annotation. More... | |
Header file for PDF Annotation module of Foxit PDF SDK.
Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.
The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. You cannot distribute any part of Foxit PDF SDK to any third party or general public, unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.
This header file defines PDF annotation supports, mainly about "writing" methods.
It contains:
Special attention:
