Header file for PDF Annotation module of Foxit PDF SDK. More...

Classes
struct	FSPDF_ANNOTICONFIT
	Structure for annotation icon fit. More...

struct	FSPDF_ANNOTBORDER
	Structure for annotation border. More...

Macros
Macro Definitions for Annotation Types
Note Annotation types are used as parameter like filter or type in some functions.
#define	FSPDF_ANNOTTYPE_TEXT "Text"
	Text annotation, markup type.

#define	FSPDF_ANNOTTYPE_LINK "Link"
	Link annotation.

#define	FSPDF_ANNOTTYPE_FREETEXT "FreeText"
	Free text annotation, markup type.

#define	FSPDF_ANNOTTYPE_LINE "Line"
	Line annotation, markup type.

#define	FSPDF_ANNOTTYPE_SQUARE "Square"
	Square annotation, markup type.

#define	FSPDF_ANNOTTYPE_CIRCLE "Circle"
	Circle annotation, markup type.

#define	FSPDF_ANNOTTYPE_POLYGON "Polygon"
	Polygon annotation, markup type.

#define	FSPDF_ANNOTTYPE_POLYLINE "PolyLine"
	Polyline annotation, markup type.

#define	FSPDF_ANNOTTYPE_HIGHLIGHT "Highlight"
	Highlight annotation, markup type.

#define	FSPDF_ANNOTTYPE_UNDERLINE "Underline"
	Underline annotation, markup type.

#define	FSPDF_ANNOTTYPE_SQUIGGLY "Squiggly"
	Squiggly-underline annotation, markup type.

#define	FSPDF_ANNOTTYPE_STRIKEOUT "StrikeOut"
	Strikeout annotation, markup type.

#define	FSPDF_ANNOTTYPE_STAMP "Stamp"
	Rubber stamp annotation, markup type.

#define	FSPDF_ANNOTTYPE_CARET "Caret"
	Caret annotation, markup type.

#define	FSPDF_ANNOTTYPE_INK "Ink"
	Ink annotation, markup type.

#define	FSPDF_ANNOTTYPE_POPUP "Popup"
	Pop-up annotation.

#define	FSPDF_ANNOTTYPE_FILEATTACHMENT "FileAttachment"
	File attachment annotation, markup type.

#define	FSPDF_ANNOTTYPE_SOUND "Sound"
	Sound annotation, markup type. More...

#define	FSPDF_ANNOTTYPE_MOVIE "Movie"
	Movie annotation. More...

#define	FSPDF_ANNOTTYPE_WIDGET "Widget"
	Widget annotation. More...

#define	FSPDF_ANNOTTYPE_SCREEN "Screen"
	Screen annotation. More...

#define	FSPDF_ANNOTTYPE_PRINTERMARK "PrinterMark"
	Printer's mark annotation. More...

#define	FSPDF_ANNOTTYPE_TRAPNET "TrapNet"
	Trap network annotation. More...

#define	FSPDF_ANNOTTYPE_WATERMARK "Watermark"
	Watermark annotation. More...

#define	FSPDF_ANNOTTYPE_PSI "PSInk"
	Pressure Sensitive Ink annotation. Currently not support. More...

#define	FSPDF_ANNOTTYPE_3D "3D"
	3D annotation. More...

Macro Definitions for Annotation Flags
#define	FSPDF_ANNOTFLAG_INVISIBLE 0x0001
	Annotation flag: invisible.

#define	FSPDF_ANNOTFLAG_HIDDEN 0x0002
	Annotation flag: hidden.

#define	FSPDF_ANNOTFLAG_PRINT 0x0004
	Annotation flag: print.

#define	FSPDF_ANNOTFLAG_NOZOOM 0x0008
	Annotation flag: no zoom.

#define	FSPDF_ANNOTFLAG_NOROTATE 0x0010
	Annotation flag: no rotate.

#define	FSPDF_ANNOTFLAG_NOVIEW 0x0020
	Annotation flag: no view.

#define	FSPDF_ANNOTFLAG_READONLY 0x0040
	Annotation flag: read only.

#define	FSPDF_ANNOTFLAG_LOCKED 0x0080
	Annotation flag: locked.

#define	FSPDF_ANNOTFLAG_TOGGLENOVIEW 0x0100
	Annotation flag: toggle no view.

#define	FSPDF_ANNOTFLAG_LOCKEDCONTENTS 0x0200
	Annotation flag: locked contents.

Macro Definitions for Icon Names
#define	FSPDF_ANNOT_ICONNAME_TEXT_CHECKMARK "Checkmark"
	Note icon type: Checkmark.

#define	FSPDF_ANNOT_ICONNAME_TEXT_CIRCLE "Circle"
	Note icon type: Circle.

#define	FSPDF_ANNOT_ICONNAME_TEXT_COMMENT "Comment"
	Note icon type: Comment.

#define	FSPDF_ANNOT_ICONNAME_TEXT_CROSS "Cross"
	Note icon type: Cross.

#define	FSPDF_ANNOT_ICONNAME_TEXT_HELP "Help"
	Note icon type: Help.

#define	FSPDF_ANNOT_ICONNAME_TEXT_INSERT "Insert"
	Note icon type: Insert.

#define	FSPDF_ANNOT_ICONNAME_TEXT_KEY "Key"
	Note icon type: Key.

#define	FSPDF_ANNOT_ICONNAME_TEXT_NEWPARAGRAPH "NewParagraph"
	Note icon type: New Paragraph.

#define	FSPDF_ANNOT_ICONNAME_TEXT_NOTE "Note"
	Note icon type: Note.

#define	FSPDF_ANNOT_ICONNAME_TEXT_PARAGRAPH "Paragraph"
	Note icon type: Paragraph.

#define	FSPDF_ANNOT_ICONNAME_TEXT_RIGHARROW "RightArrow"
	Note icon type: Right Arrow.

#define	FSPDF_ANNOT_ICONNAME_TEXT_RIGHPOINTER "RightPointer"
	Note icon type: Right Pointer.

#define	FSPDF_ANNOT_ICONNAME_TEXT_STAR "Star"
	Note icon type: Star.

#define	FSPDF_ANNOT_ICONNAME_TEXT_UPARROW "UpArrow"
	Note icon type: Up Arrow.

#define	FSPDF_ANNOT_ICONNAME_TEXT_UPLEFTARROW "UpleftArrow"
	Note icon type: Up-left Arrow.

#define	FSPDF_ANNOT_ICONNAME_FILEATTACH_GRAPH "Graph"
	File attachment icon type: Graph.

#define	FSPDF_ANNOT_ICONNAME_FILEATTACH_PAPERCLIP "Paperclip"
	File attachment icon type: PaperClip.

#define	FSPDF_ANNOT_ICONNAME_FILEATTACH_PUSHPIN "PushPin"
	File attachment icon type: PushPin.

#define	FSPDF_ANNOT_ICONNAME_FILEATTACH_TAG "Tag"
	File attachment icon type: Tag.

#define	FSPDF_ANNOT_ICONNAME_STAMP_APPROVED "Approved"
	Stamp annotation icon type: Approved.

#define	FSPDF_ANNOT_ICONNAME_STAMP_ASIS "AsIs"
	Stamp annotation icon type: AsIs.

#define	FSPDF_ANNOT_ICONNAME_STAMP_CONFIDENTIAL "Confidential"
	Stamp annotation icon type: Confidential.

#define	FSPDF_ANNOT_ICONNAME_STAMP_DEPARTMENTAL "Departmental"
	Stamp annotation icon type: Departmental.

#define	FSPDF_ANNOT_ICONNAME_STAMP_DRAFT "Draft"
	Stamp annotation icon type: Draft.

#define	FSPDF_ANNOT_ICONNAME_STAMP_EXPERIMENTAL "Experimental"
	Stamp annotation icon type: Experimental.

#define	FSPDF_ANNOT_ICONNAME_STAMP_EXPIRED "Expired"
	Stamp annotation icon type: Expired.

#define	FSPDF_ANNOT_ICONNAME_STAMP_FINAL "Final"
	Stamp annotation icon type: Final.

#define	FSPDF_ANNOT_ICONNAME_STAMP_FORCOMMENT "ForComment"
	Stamp annotation icon type: ForComment.

#define	FSPDF_ANNOT_ICONNAME_STAMP_FORPUBLICRELEASE "ForPublicRelease"
	Stamp annotation icon type: ForPublicRelease.

#define	FSPDF_ANNOT_ICONNAME_STAMP_NOTAPPROVED "NotApproved"
	Stamp annotation icon type: NotApproved.

#define	FSPDF_ANNOT_ICONNAME_STAMP_NOTFORPUBLICRELEASE "NotForPublicRelease"
	Stamp annotation icon type: NotForPublicRelease.

#define	FSPDF_ANNOT_ICONNAME_STAMP_SOLD "Sold"
	Stamp annotation icon type: Sold.

#define	FSPDF_ANNOT_ICONNAME_STAMP_TOPSECRET "TopSecret"
	Stamp annotation icon type: TopSecret.

#define	FSPDF_ANNOT_ICONNAME_SOUND_SPEAKER "Speaker"
	Sound annotation icon type: Speaker.

#define	FSPDF_ANNOT_ICONNAME_SOUND_MIC "Mic"
	Sound annotation icon type: Mic.

Macro Definitions for Intent Names
#define	FSPDF_ANNOT_INTENTNAME_FREETEXT_CALLOUT "FreeTextCallout"
	FreeText annotation intent name: FreeTextCallout.

#define	FSPDF_ANNOT_INTENTNAME_FREETEXT_TYPEWRITER "FreeTextTypewriter"
	FreeText annotation intent name: FreeTextTypewriter.

#define	FSPDF_ANNOT_INTENTNAME_LINE_ARROW "LineArrow"
	Line annotation intent name: LineArrow.

#define	FSPDF_ANNOT_INTENTNAME_LINE_DIMENSION "LineDimension"
	Line annotation intent name: LineDimension.

#define	FSPDF_ANNOT_INTENTNAME_POLYGON_CLOUD "PolygonCloud"
	Polygon annotation intent name: PolygonCloud.

#define	FSPDF_ANNOT_INTENTNAME_POLYGON_DIMENSION "PolygonDimension"
	Polygon annotation intent name: PolygonDimension.

#define	FSPDF_ANNOT_INTENTNAME_POLYLINE_DIMENSION "PolyLineDimension"
	PolyLine annotation intent name: PolyLineDimension.

Macro Definitions for Line Ending Styles
#define	FSPDF_ANNOT_LINEENDINGSTYLE_NONE "None"
	Line annotation ending style name: None.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_SQUARE "Square"
	Line annotation ending style name: Square.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_CIRCLE "Circle"
	Line annotation ending style name: Circle.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_DIAMOND "Diamond"
	Line annotation ending style name: Diamond.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_OPENARROW "OpenArrow"
	Line annotation ending style name: OpenArrow.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_CLOSEDARROW "ClosedArrow"
	Line annotation ending style name: ClosedArrow.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_BUTT "Butt"
	Line annotation ending style name: Butt.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_REVERSEOPENARROW "ROpenArrow"
	Line annotation ending style name: ROpenArrow.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_REVERSECLOSEDARROW "RClosedArrow"
	Line annotation ending style name: RClosedArrow.

#define	FSPDF_ANNOT_LINEENDINGSTYLE_SLASH "Slash"
	Line annotation ending style name: Slash.

Macro Definitions for Highlighting Modes
#define	FSPDF_ANNOT_HIGHLIGHTINGMODE_NONE 0
	Highlighting mode: None.

#define	FSPDF_ANNOT_HIGHLIGHTINGMODE_INVERT 1
	Highlighting mode: Invert.

#define	FSPDF_ANNOT_HIGHLIGHTINGMODE_OUTLINE 2
	Highlighting mode: Outline.

#define	FSPDF_ANNOT_HIGHLIGHTINGMODE_PUSH 3
	Highlighting mode: Push.

#define	FSPDF_ANNOT_HIGHLIGHTINGMODE_TOGGLE 4
	Highlighting mode: Toggle. More...

Macro Definitions for Border Style
#define	FSPDF_ANNOT_BORDERSTYLE_SOLID 0
	Border style: Solid.

#define	FSPDF_ANNOT_BORDERSTYLE_DASHED 1
	Border style: Dashed.

#define	FSPDF_ANNOT_BORDERSTYLE_UNDERLINE 2
	Border style: Underline.

#define	FSPDF_ANNOT_BORDERSTYLE_BEVELED 3
	Border style: Beveled.

#define	FSPDF_ANNOT_BORDERSTYLE_INSET 4
	Border style: Inset.

#define	FSPDF_ANNOT_BORDERSTYLE_CLOUDY 5
	Border style: Cloudy.

Macro Definitions for Icon Fit Flags
#define	FSPDF_ANNOT_ICONFITFLAG_SCALEWAY 1
	Icon fit flag: Scale way.

#define	FSPDF_ANNOT_ICONFITFLAG_ASPECTRATIO 2
	Icon fit flag: Aspect ratio.

#define	FSPDF_ANNOT_ICONFITFLAG_POSITION 4
	Icon fit flag: Set position.

#define	FSPDF_ANNOT_ICONFITFLAG_FITBOUNDS 8
	Icon fit flag: Fit boundaries.

Macro Definitions for Icon Scale Way
#define	FSPDF_ANNOT_ICONSCALEWAY_ALWAYS 0
	A: Always scale.

#define	FSPDF_ANNOT_ICONSCALEWAY_BIGGER 1
	B: Scale only when icon is bigger than annotation rectangle.

#define	FSPDF_ANNOT_ICONSCALEWAY_SMALLER 2
	S: Scale only when icon is smaller than annotation rectangle.

#define	FSPDF_ANNOT_ICONSCALEWAY_NEVER 3
	N: Never scale.

Macro Definitions for Entries in Appearance Characteristics (MK)
#define	FSPDF_ANNOT_MKENTRY_ROTATION 0
	Entry of appearance characteristics dictionary: R.

#define	FSPDF_ANNOT_MKENTRY_BORDERCOLOR 1
	Entry of appearance characteristics dictionary: BC.

#define	FSPDF_ANNOT_MKENTRY_BACKGROUNDCOLOR 2
	Entry of appearance characteristics dictionary: BG.

#define	FSPDF_ANNOT_MKENTRY_NORMALCAPTION 3
	Entry of appearance characteristics dictionary: CA, only for widget annotation with any button fields.

#define	FSPDF_ANNOT_MKENTRY_ROLLOVERCAPTION 4
	Entry of appearance characteristics dictionary: RC, only for widget annotation with pushbutton fields.

#define	FSPDF_ANNOT_MKENTRY_DOWNCAPTION 5
	Entry of appearance characteristics dictionary: AC, only for widget annotation with pushbutton fields.

#define	FSPDF_ANNOT_MKENTRY_NORMALICON 6
	Entry of appearance characteristics dictionary: I, only for widget annotation with pushbutton fields.

#define	FSPDF_ANNOT_MKENTRY_ROLLOVERICON 7
	Entry of appearance characteristics dictionary: RI, only for widget annotation with pushbutton fields.

#define	FSPDF_ANNOT_MKENTRY_DOWNICON 8
	Entry of appearance characteristics dictionary: IX, only for widget annotation with pushbutton fields.

#define	FSPDF_ANNOT_MKENTRY_ICONFIT 9
	Entry of appearance characteristics dictionary: IF, only for widget annotation with pushbutton fields.

#define	FSPDF_ANNOT_MKENTRY_TEXTPOSITION 10
	Entry of appearance characteristics dictionary: TP, only for widget annotation with pushbutton fields.

Macro Definition for Annotation State Model
#define	FSPDF_ANNOTSTATEMODEL_MARKED 0
	State model is marked.

#define	FSPDF_ANNOTSTATEMODEL_REVIEW 1
	State model is review.

Macro Definition for Annotation Marked State
These are meaningful when state model is FSPDF_ANNOTSTATEMODEL_MARKED.
#define	FSPDF_ANNOTSTATE_MARKED_MARKED 0
	The state of marked model is marked.

#define	FSPDF_ANNOTSTATE_MARKED_UNMARKED 1
	The state of marked model is unmarked.

#define	FSPDF_ANNOTSTATE_REVIEW_ACCEPTED 0
	The state of review model is accepted.

#define	FSPDF_ANNOTSTATE_REVIEW_REJECTED 1
	The state of review model is rejected.

#define	FSPDF_ANNOTSTATE_REVIEW_CANCELLED 2
	The state of review model is canceled.

#define	FSPDF_ANNOTSTATE_REVIEW_COMPLETED 3
	The state of review model is completed.

#define	FSPDF_ANNOTSTATE_REVIEW_NONE 4
	The state of review model is none.

Functions
FS_RESULT	FSPDF_Page_LoadAnnots (FSCRT_PAGE page)
	Load annotations from a PDF page. More...

FS_RESULT	FSPDF_Page_UnloadAnnots (FSCRT_PAGE page)
	Unload annotations of a PDF page. More...

FS_RESULT	FSPDF_Annot_GetCount (FSCRT_PAGE page, const FSCRT_BSTR filter, FS_INT32 count)
	Get count of annotations, by specific filter. More...

FS_RESULT	FSPDF_Annot_Get (FSCRT_PAGE page, const FSCRT_BSTR filter, FS_INT32 index, FSCRT_ANNOT annot)
	Get annotation with specified index, by specific filter. More...

FS_RESULT	FSPDF_Annot_GetAtPos (FSCRT_PAGE page, const FSCRT_BSTR filter, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSCRT_ANNOT annot)
	Get annotation at a specific position in PDF page, by specific filter. More...

FS_RESULT	FSPDF_Annot_GetAtDevicePos (FSCRT_PAGE page, const FSCRT_BSTR filter, const FSCRT_MATRIX matrix, FS_INT32 x, FS_INT32 y, FS_INT32 tolerance, FSCRT_ANNOT *annot)
	Get annotation at a specific position in device (in pixel), by specific filter. More...

FS_RESULT	FSPDF_Annot_GetIndex (FSCRT_ANNOT annot, const FSCRT_BSTR filter, FS_INT32 index)
	Get index of a specific annotation, by specific filter. More...

FS_RESULT	FSPDF_Annot_GetAllByTabOrder (FSCRT_PAGE page, const FSCRT_BSTR filter, FSCRT_ANNOT annotArray, FS_INT32 *count)
	Get annotations by tab order, with specific filter (except pop-up annotation). More...

FS_RESULT	FSPDF_Annot_GetType (FSCRT_ANNOT annot, FSCRT_BSTR *annotType)
	Get type of an annotation. More...

FS_RESULT	FSPDF_Annot_GetRect (FSCRT_ANNOT annot, FSCRT_RECTF *rect)
	Get rectangle of an annotation. More...

FS_RESULT	FSPDF_Annot_GetDeviceRect (FSCRT_ANNOT annot, FS_BOOL bTransformIcon, const FSCRT_MATRIX matrix, FSCRT_RECT deviceRect)
	Get rectangle of an annotation in device coordinations. More...

FS_RESULT	FSPDF_Annot_GetFlags (FSCRT_ANNOT annot, FS_DWORD *flags)
	Get flags of an annotation. More...

FS_RESULT	FSPDF_Annot_GetName (FSCRT_ANNOT annot, FSCRT_BSTR *name)
	Get name of an annotation. More...

FS_RESULT	FSPDF_Annot_GetContents (FSCRT_ANNOT annot, FSCRT_BSTR *contents)
	Get contents of an annotation. More...

FS_RESULT	FSPDF_Annot_GetBorder (FSCRT_ANNOT annot, FSPDF_ANNOTBORDER *border)
	Get border of an annotation. More...

FS_RESULT	FSPDF_Annot_GetColor (FSCRT_ANNOT annot, FS_BOOL isFillColor, FS_ARGB *color)
	Get fill or border color of an annotation. More...

FS_RESULT	FSPDF_Annot_GetModifiedDateTime (FSCRT_ANNOT annot, FSCRT_DATETIMEZONE *dt)
	Get modification time of an annotation. More...

FS_RESULT	FSPDF_Annot_GetCreationDateTime (FSCRT_ANNOT annot, FSCRT_DATETIMEZONE *dt)
	Get creation time of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetSubject (FSCRT_ANNOT annot, FSCRT_BSTR *subject)
	Get subject of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetTitle (FSCRT_ANNOT annot, FSCRT_BSTR *title)
	Get title of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetOpacity (FSCRT_ANNOT annot, FS_FLOAT *opacity)
	Get opacity of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetIntent (FSCRT_ANNOT annot, FSCRT_BSTR *intent)
	Get intent of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetOpenStatus (FSCRT_ANNOT annot, FS_BOOL *isOpen)
	Get open status of a text or pop-up annotation. More...

FS_RESULT	FSPDF_Annot_GetIconName (FSCRT_ANNOT annot, FSCRT_BSTR *iconName)
	Get icon name of an annotation. More...

FS_RESULT	FSPDF_Annot_GetAlignment (FSCRT_ANNOT annot, FS_INT32 *alignment)
	Get alignment of a free text annotation. More...

FS_RESULT	FSPDF_Annot_GetHighlightingMode (FSCRT_ANNOT annot, FS_INT32 *hlMode)
	Get highlighting mode of a link or widget annotation. More...

FS_RESULT	FSPDF_Annot_GetQuadPoints (FSCRT_ANNOT annot, FSCRT_QUADPOINTSF quadPoints, FS_INT32 count)
	Get quadrilaterals points of an annotation. More...

FS_RESULT	FSPDF_Annot_GetCalloutLinePoints (FSCRT_ANNOT annot, FS_FLOAT x1, FS_FLOAT y1, FS_FLOAT x2, FS_FLOAT y2, FS_FLOAT x3, FS_FLOAT y3)
	Get callout line points of a free text annotation. More...

FS_RESULT	FSPDF_Annot_GetInnerRectMargin (FSCRT_ANNOT annot, FS_FLOAT left, FS_FLOAT top, FS_FLOAT right, FS_FLOAT bottom)
	Get the margin between inner rectangle and rectangle of an annotation. More...

FS_RESULT	FSPDF_Annot_GetLineEndingStyles (FSCRT_ANNOT annot, FSCRT_BSTR startingStyle, FSCRT_BSTR endingStyle)
	Get line ending styles of an annotation. More...

FS_RESULT	FSPDF_Annot_GetLinePosition (FSCRT_ANNOT annot, FS_FLOAT x1, FS_FLOAT y1, FS_FLOAT x2, FS_FLOAT y2)
	Get line position of a line annotation. More...

FS_RESULT	FSPDF_Annot_GetLeaderLineLength (FSCRT_ANNOT annot, FS_FLOAT *length)
	Get leader line length of a line annotation. More...

FS_RESULT	FSPDF_Annot_GetLeaderLineExtension (FSCRT_ANNOT annot, FS_FLOAT *extLength)
	Get leader line extension of a line annotation. More...

FS_RESULT	FSPDF_Annot_GetLeaderLineOffset (FSCRT_ANNOT annot, FS_FLOAT *offset)
	Get leader line offset of a line annotation. More...

FS_RESULT	FSPDF_Annot_HasCaptionContents (FSCRT_ANNOT annot, FS_BOOL *hasCap)
	Check if there is a caption to a line annotation. More...

FS_RESULT	FSPDF_Annot_GetCaptionPosition (FSCRT_ANNOT annot, FSCRT_BSTR *captionPos)
	Get caption position of a line annotation. More...

FS_RESULT	FSPDF_Annot_GetCaptionOffset (FSCRT_ANNOT annot, FS_FLOAT offsetx, FS_FLOAT offsety)
	Get caption offset of a line annotation. More...

FS_RESULT	FSPDF_Annot_GetVertices (FSCRT_ANNOT annot, FS_FLOAT vertices, FS_INT32 count)
	Get vertices of a polygon or polyline annotation. More...

FS_RESULT	FSPDF_Annot_GetSymbol (FSCRT_ANNOT annot, FSCRT_BSTR *symbol)
	Get symbol of a caret annotation. More...

FS_RESULT	FSPDF_Annot_GetInkList (FSCRT_ANNOT annot, FSCRT_PATHDATA *pathData)
	Get ink list data of an ink annotation. More...

FS_RESULT	FSPDF_Annot_GetAttachment (FSCRT_ANNOT annot, FSPDF_ATTACHMENT *attachment)
	Get attachment of a file attachment annotation. More...

FS_RESULT	FSPDF_Annot_GetDefaultAppearance (FSCRT_ANNOT annot, FSPDF_DEFAULTAPPEARANCE *defAppearance)
	Get default appearance of a free text annotation, which can be used in formatting text. More...

FS_RESULT	FSPDF_Annot_GetIconFit (FSCRT_ANNOT annot, FSPDF_ANNOTICONFIT *iconFit)
	Get icon fit of a widget annotation. More...

FS_RESULT	FSPDF_Annot_HasMKEntry (FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_BOOL *hasEntry)
	Check if specific entry is in MK dictionary. More...

FS_RESULT	FSPDF_Annot_GetMKRotation (FSCRT_ANNOT annot, FS_INT32 *degree)
	Get rotation (the number of degrees) in MK dictionary. More...

FS_RESULT	FSPDF_Annot_GetMKColor (FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_ARGB *color)
	Get color of specific type in MK dictionary. More...

FS_RESULT	FSPDF_Annot_GetMKCaption (FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BSTR *caption)
	Get caption of a specific type in MK dictionary. More...

FS_RESULT	FSPDF_Annot_GetMKIconBitmap (FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BITMAP *bitmap)
	Get icon bitmap of specific icon type in MK dictionary. More...

FS_RESULT	FSPDF_Annot_GetFormControl (FSCRT_ANNOT widgetAnnot, FSPDF_FORMCONTROL *formControl)
	Get a PDF form control from a widget annotation handle. More...

FS_RESULT	FSPDF_Annot_GetDict (FSCRT_ANNOT annot, FSPDF_OBJECT *dictionary)
	Get the dictionary of an annotation. More...

FS_RESULT	FSPDF_Annot_CountStateAnnots (FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 *count)
	Count specific state annotations associated with a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetStateAnnot (FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 index, FSCRT_ANNOT *stateAnnot)
	Get specified state annotation associated with a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetState (FSCRT_ANNOT stateAnnot, FS_INT32 stateModel, FS_INT32 state)
	Get state model and state out of a state text annotation. More...

FS_RESULT	FSPDF_Annot_IsGrouped (FSCRT_ANNOT annot, FS_BOOL *isGrouped)
	Check whether an annotation is in a group. More...

FS_RESULT	FSPDF_Annot_GetGroupHeader (FSCRT_ANNOT annot, FSCRT_ANNOT *groupHeader)
	Get header annotation of a group, to which an annotation belongs. More...

FS_RESULT	FSPDF_Annot_GetGroupElements (FSCRT_ANNOT annot, FSCRT_ANNOT elements, FS_INT32 count)
	Get group elements if annotation is in a group, including itself. More...

FS_RESULT	FSPDF_Annot_CountReplies (FSCRT_ANNOT annot, FS_INT32 *count)
	Count replies of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetReply (FSCRT_ANNOT annot, FS_INT32 index, FSCRT_ANNOT *replyAnnot)
	Get reply with specifies index of a markup annotation. More...

FS_RESULT	FSPDF_Annot_GetPopup (FSCRT_ANNOT annot, FSCRT_ANNOT *popupAnnot)
	Get a pop-up annotation from a specific markup annotation. More...

FS_RESULT	FSPDF_Annot_CountActions (FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 *count)
	Count actions associated with an annotation. More...

FS_RESULT	FSPDF_Annot_GetAction (FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA *actionData)
	Get action data of specific index associated with an annotation. More...

FS_RESULT	FSPDF_RenderContext_StartAnnots (FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, const FSCRT_ANNOT annots, FS_INT32 count, FSCRT_PROGRESS renderProgress)
	Render annotations on render context. More...

FS_RESULT	FSPDF_RenderContext_StartPageAnnots (FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, FSCRT_PAGE page, FSCRT_PROGRESS *renderProgress)
	Render all annotations of a page on render context. More...

Detailed Description

Header file for PDF Annotation module of Foxit PDF SDK.

http://www.foxitsoftware.com

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 "reading" methods.
It contains:

1. Load or unload annotations from a PDF page.
2. Enumerate annotations.
3. Get common properties of annotations.
4. Supports to markup annotations.
5. Get annotation trigger actions.
6. Render annotations.

Special attention:

For watermark annotation, user should use functions in PDF Watermark module for most operations of watermark.
For PSInk annotation, user should use function FSCRT_PSI_ConvertToPDFAnnot in Pressure Sensitive Ink to generate a PSInk annotation from a PSI object.
For Sound, Movie, Screen, PrinterMark, TrapNet and 3D annotations, currently Foxit PDF SDK provides common access to them and their basic properties, not support access to their data.
For annotation which is not defined in PDF Reference but consists of some standard annotations, it will be treated as different standard annotations. If user wants to treat these standard annotations as one special annotation, user should do this in application layer.

Note: If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Annotation Add-on or Form Add-on explicitly.

Classes

Macros

Functions

Detailed Description