annots.h File Reference

Annotations API. More...

#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/content.h>
#include <pdfsdk/core/document.h>
#include <pdfsdk/core/types.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>

Go to the source code of this file.

Classes
struct	PDAnnotBorder
struct	PDAnnotBorderStyle
struct	PDAnnotBorderEffect
struct	PDStampAnnotCreateDynamicAppearanceStreamParams
struct	PDTextAnnotCreationParams
struct	PDInkList
struct	PDInkAnnotCreationParams
struct	PDSquareOrCircleAnnotCreationParamsRec_
struct	PDLineEnding
struct	PDLineAnnotCreationParams
struct	PDPolyLineAnnotCreationParams
struct	PDStampAnnotCreationParams
struct	PDTextMarkupAnnotCreationParams
struct	PDLinkAnnotCreationParams
struct	PDRedactAnnotCreationParams
struct	PDFileAttachmentAnnotCreationParams
struct	PDFreeTextAnnotCreationParams
struct	PDCaretAnnotCreationParams

Macros
#define	kPDAnnotBorderMaxDashes   11

Typedefs
typedef void(PDFSDK_CALLCONV *	PDAnnotChangedProc) (PDAnnotOperation operation, size_t iPage, PDAnnot, void *clientData)
typedef uint32_t	PDAnnotFlags
typedef PDSquareOrCircleAnnotCreationParamsRec_	PDCircleAnnotCreationParams
typedef PDSquareOrCircleAnnotCreationParamsRec_	PDSquareAnnotCreationParams

Enumerations
enum	PDAnnotOperation { kPDAnnotAdded , kPDAnnotRemoved , kPDAnnotChanged , kPDAnnotValueChanged }
	Defines actions or changes applied to annotations within a PDF document. More...
enum	{   kPDAnnotFlagInvisible = 1 << 0 , kPDAnnotFlagHidden = 1 << 1 , kPDAnnotFlagPrint = 1 << 2 , kPDAnnotFlagNoZoom = 1 << 3 ,   kPDAnnotFlagNoRotate = 1 << 4 , kPDAnnotFlagNoView = 1 << 5 , kPDAnnotFlagReadOnly = 1 << 6 , kPDAnnotFlagLocked = 1 << 7 ,   kPDAnnotFlagToggleNoView = 1 << 8 , kPDAnnotFlagLockedContents = 1 << 9 }
	Defines the visibility, behavior, and interaction of annotations within a PDF document. More...
enum	PDAnnotState { kPDAnnotStateNormal , kPDAnnotStateRollover , kPDAnnotStateDown }
	Defines visual appearance of an annotation at different times based on user interaction. More...
enum	PDAnnotBorderType {   kPDAnnotBorderTypeSolid , kPDAnnotBorderTypeDashed , kPDAnnotBorderTypeBeveled , kPDAnnotBorderTypeInset ,   kPDAnnotBorderTypeUnderline }
	Defines the visual style of the borders around an annotation. More...
enum	PDAnnotBorderEffectStyle { kPDAnnotBorderEffectStyleNone , kPDAnnotBorderEffectStyleCloudy }
	Defines the border effect of an annotation. More...
enum	PDQuadding { kPDQuaddingLeft = 0 , kPDQuaddingCenter = 1 , kPDQuaddingRight = 2 }
	Defines the alignment of text for a free text annotation. More...
enum	PDMarkupAnnotReplyType { kPDMarkupAnnotReplyReply , kPDMarkupAnnotReplyGroup }
	Defines the relationship between markup annotations. More...
enum	PDAnnotHighlightMode {   kPDAnnotHighlightNone , kPDAnnotHighlightInvert , kPDAnnotHighlightOutline , kPDAnnotHighlightPush ,   kPDAnnotHighlightToggle }
	Defines the visual representation of annotations, making it easier for users to interact with and understand a PDF document. More...

Functions
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocAttachAnnotWillChangeCallback (PDDoc doc, PDAnnotChangedProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocDetachAnnotWillChangeCallback (PDDoc doc, PDAnnotChangedProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocNotifyAnnotWillChange (PDDoc doc, PDAnnotOperation operation, size_t iPage, PDAnnot annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocAttachAnnotChangedCallback (PDDoc doc, PDAnnotChangedProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocDetachAnnotChangedCallback (PDDoc doc, PDAnnotChangedProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocNotifyAnnotChanged (PDDoc doc, PDAnnotOperation operation, size_t iPage, PDAnnot annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageGetNumAnnots (PDPage page, size_t *pNumAnnots)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageGetAnnot (PDPage page, size_t index, PDAnnot *pAnnot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageAddAnnot (PDPage page, size_t insertAt, PDAnnot annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageRemoveAnnot (PDPage page, PDAnnot annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageRemoveAnnotByIndex (PDPage page, size_t index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPageGetAnnotIndex (PDPage page, PDAnnot annot, size_t *pIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotCreate (PDDoc doc, PDAtom annotType, const void *createParams, PDAnnot *annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetPDObject (PDAnnot annot, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetSubtype (PDAnnot annot, PDAtom *pSubtype)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetFlags (PDAnnot annot, PDAnnotFlags flags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetFlags (PDAnnot annot, PDAnnotFlags *pFlags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetRect (PDAnnot annot, const PDRectF *rect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetRect (PDAnnot annot, PDRectF *pRect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetColor (PDAnnot annot, PDColorValue color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetColor (PDAnnot annot, PDColorValue *pColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetContents (PDAnnot annot, const wchar_t *buffer, size_t bufSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetContents (PDAnnot annot, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetModDate (PDAnnot annot, const PDDateTime *date)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetModDate (PDAnnot annot, PDDateTime *pDate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetBorder (PDAnnot annot, const PDAnnotBorder *border)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetBorder (PDAnnot annot, PDAnnotBorder *pBorder)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetOCMD (PDAnnot annot, PDOCMD ocmd)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetOCMD (PDAnnot annot, PDOCMD *pOCMD)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDOCConfigIsAnnotVisible (PDOCConfig config, PDAnnot annot, bool *pVisible)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetAppearanceState (PDAnnot annot, PDAtom appState)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetAppearanceState (PDAnnot annot, PDAtom *pAppState)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetFillOpacity (PDAnnot annot, float opacity)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetFillOpacity (PDAnnot annot, float *pOpacity)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetStrokeOpacity (PDAnnot annot, float opacity)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetStrokeOpacity (PDAnnot annot, float *pOpacity)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotHasAppearance (PDAnnot annot, PDAnnotState state, PDAtom appState, bool *pHas)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetName (PDAnnot annot, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetName (PDAnnot annot, const wchar_t *buffer, size_t bufSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetVisible (PDAnnot annot, bool *visible)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetVisible (PDAnnot annot, bool visible)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetBlendMode (PDAnnot annot, PDEBlendMode *pBlendMode)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetBlendMode (PDAnnot annot, PDEBlendMode blendMode)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotSetAppearance (PDAnnot annot, PDAnnotState state, PDAtom appState, PDEXObject app)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotGetAppearance (PDAnnot annot, PDAnnotState state, PDAtom appState, PDEXObject *pApp)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotSetAction (PDAnnot annot, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotGetAction (PDAnnot annot, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotRemoveAction (PDAnnot annot)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotSetQuadPoints (PDAnnot annot, size_t numQuads, const PDQuad *quads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotGetNumQuads (PDAnnot annot, size_t *pNumQuads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotGetQuadPoints (PDAnnot annot, PDQuad *quads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *pBorderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotSetDestination (PDAnnot annot, PDDest dest)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLinkAnnotGetDestination (PDAnnot annot, PDDest *pDest)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDAnnotIsMarkupAnnot (PDAnnot annot, bool *pMarkup)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetTitle (PDAnnot annot, const wchar_t *buffer, size_t bufSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetTitle (PDAnnot annot, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetPopup (PDAnnot annot, PDAnnot *pPopup)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetRichContents (PDAnnot annot, const wchar_t *buffer, size_t bufSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetRichContents (PDAnnot annot, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetCreationDate (PDAnnot annot, const PDDateTime *date)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetCreationDate (PDAnnot annot, PDDateTime *pDate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetSubject (PDAnnot annot, const wchar_t *buffer, size_t bufSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetSubject (PDAnnot annot, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetInReplyTo (PDAnnot annot, PDAnnot *pInReplyTo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetInReplyTo (PDAnnot annot, PDAnnot inReplyTo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetReplyType (PDAnnot annot, PDMarkupAnnotReplyType replyType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetReplyType (PDAnnot annot, PDMarkupAnnotReplyType *pReplyType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotSetIntent (PDAnnot annot, PDAtom intent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDMarkupAnnotGetIntent (PDAnnot annot, PDAtom *pIntent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextAnnotSetOpen (PDAnnot annot, bool open)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextAnnotIsOpen (PDAnnot annot, bool *pOpen)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextMarkupAnnotSetQuadPoints (PDAnnot annot, size_t numQuads, const PDQuad *quads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextMarkupAnnotGetNumQuads (PDAnnot annot, size_t *pNumQuads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextMarkupAnnotGetQuadPoints (PDAnnot annot, PDQuad *quads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetRotate (PDAnnot annot, PDRotate *pRotate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetRotate (PDAnnot annot, PDRotate rotate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetQuadding (PDAnnot annot, PDQuadding *pQuadding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetQuadding (PDAnnot annot, PDQuadding quadding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *pBorderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetBorderEffect (PDAnnot annot, PDAnnotBorderEffect *pBorderEffect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetBorderEffect (PDAnnot annot, const PDAnnotBorderEffect *borderEffect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetFontInfo (PDAnnot annot, PDFontInfo *pFontInfo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetFontInfo (PDAnnot annot, const PDFontInfo *fontInfo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetFontColor (PDAnnot annot, PDColorValue *pFontColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetFontColor (PDAnnot annot, PDColorValue fontColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetBorderColor (PDAnnot annot, PDColorValue *pFontColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetBorderColor (PDAnnot annot, PDColorValue fontColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetFontSize (PDAnnot annot, float *pFontSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetFontSize (PDAnnot annot, float fontSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetLineEnding (PDAnnot annot, PDAtom *pEndPointStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetLineEnding (PDAnnot annot, PDAtom endPointStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetRectDifferences (PDAnnot annot, PDRectF *pDifferences)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetRectDifferences (PDAnnot annot, const PDRectF *differences)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotHitTestChar (PDAnnot annot, const PDPointF *pagePt, size_t *pCharIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetCharQuad (PDAnnot annot, size_t index, PDQuad *pQuad)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetNumLines (PDAnnot annot, size_t *pNumLines)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetLineSpacing (PDAnnot annot, float *pLineSpacing)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetLineSpacing (PDAnnot annot, float lineSpacing)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetCharSpacing (PDAnnot annot, float *pCharSpacing)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotSetCharSpacing (PDAnnot annot, float charSpacing)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetFirstCharOnLine (PDAnnot annot, size_t lineIndex, size_t *pCharIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFreeTextAnnotGetLineWithChar (PDAnnot annot, size_t charIndex, size_t *pLineIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *pBorderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetInteriorColor (PDAnnot annot, PDEColor *color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetInteriorColor (PDAnnot annot, PDEColor color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetLeaderLineLength (PDAnnot annot, float *lenght)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetLeaderLineLength (PDAnnot annot, float lenght)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetLeaderLineExtensionLength (PDAnnot annot, float *lenght)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetLeaderLineExtensionLength (PDAnnot annot, float lenght)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetLeaderLineOffset (PDAnnot annot, float *offset)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetLeaderLineOffset (PDAnnot annot, float offset)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetShowCaption (PDAnnot annot, bool *showCaption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetShowCaption (PDAnnot annot, bool showCaption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetCaptionPosition (PDAnnot annot, PDAtom *postion)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetCaptionPosition (PDAnnot annot, PDAtom postion)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetCaptionOffset (PDAnnot annot, PDPointF *offset)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetCaptionOffset (PDAnnot annot, PDPointF offset)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetLineEnding (PDAnnot annot, PDAtom *startPointStyle, PDAtom *endPointStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetLineEnding (PDAnnot annot, PDAtom startPointStyle, PDAtom endPointStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotGetBoundaryPoints (PDAnnot annot, PDPointF *pStart, PDPointF *pEnd)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDLineAnnotSetBoundaryPoints (PDAnnot annot, const PDPointF *start, const PDPointF *end)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSquareAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSquareAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSquareAnnotGetInteriorColor (PDAnnot annot, PDEColor *color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSquareAnnotSetInteriorColor (PDAnnot annot, PDEColor color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSquareAnnotGetBorderEffect (PDAnnot annot, PDAnnotBorderEffect *borderEffect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSquareAnnotSetBorderEffect (PDAnnot annot, const PDAnnotBorderEffect *borderEffect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotGetInteriorColor (PDAnnot annot, PDEColor *color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotSetInteriorColor (PDAnnot annot, PDEColor color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolygonAnnotGetBorderEffect (PDAnnot annot, PDAnnotBorderEffect *borderEffect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolygonAnnotSetBorderEffect (PDAnnot annot, const PDAnnotBorderEffect *borderEffect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotGetShowCaption (PDAnnot annot, bool *showCaption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotSetShowCaption (PDAnnot annot, bool showCaption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotGetLineEnding (PDAnnot annot, PDAtom *startPointStyle, PDAtom *endPointStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotSetLineEnding (PDAnnot annot, PDAtom startPointStyle, PDAtom endPointStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotGetVertices (PDAnnot annot, PDPointF *buffer, size_t size, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPolyLineAnnotSetVertices (PDAnnot annot, const PDPointF *vertices, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStampAnnotCreateDynamicAppearanceStream (PDDoc doc, const PDStampAnnotCreateDynamicAppearanceStreamParams *params, PDEXObject *appearanceStream)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDInkAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDInkAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *pBorderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDInkAnnotGetInkPointListSize (PDAnnot annot, size_t *size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDInkAnnotSetInkPointListSize (PDAnnot annot, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDInkAnnotGetInkPointsByIndex (PDAnnot annot, size_t i, PDPointF *buffer, size_t size, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDInkAnnotSetInkPointsByIndex (PDAnnot annot, size_t i, const PDPointF *buffer, size_t size)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFileAttachmentAnnotSetFileSpec (PDAnnot annot, PDFileSpec pFileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFileAttachmentAnnotGetFileSpec (PDAnnot annot, PDFileSpec *pFileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotSetQuadPoints (PDAnnot annot, size_t numQuads, const PDQuad *quads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotGetNumQuads (PDAnnot annot, size_t *pNumQuads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotGetQuadPoints (PDAnnot annot, PDQuad *quads)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotGetInteriorColor (PDAnnot annot, PDEColor *color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotSetInteriorColor (PDAnnot annot, PDEColor color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotGetAppearanceFillColor (PDAnnot annot, PDEColor *color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDRedactAnnotSetAppearanceFillColor (PDAnnot annot, PDEColor color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPopupAnnotGetOpen (PDAnnot annot, bool *open)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDPopupAnnotSetOpen (PDAnnot annot, bool open)

Detailed Description

Annotations API.

Enumeration Type Documentation

anonymous enum

anonymous enum

Defines the visibility, behavior, and interaction of annotations within a PDF document.

The value of the annotation dictionary’s F entry is an integer interpreted as one-bit flags specifying various characteristics of the annotation. Bit positions within the flag word shall be numbered from low-order to high-order, with the lowest-order bit numbered 1. For more information refer to section 12.5.3 - Annotation flags in the ISO 32000-2:2020 (PDF 2.0) Standard.

Enumerator
kPDAnnotFlagInvisible	The annotation is not visible on the screen or when the document is printed. This is different from Hidden because the annotation can become visible in certain conditions, like user interaction.
kPDAnnotFlagHidden	The annotation is completely hidden and never visible on the screen or in print.
kPDAnnotFlagPrint	The annotation is printed when the document is printed, unless the Hidden flag is set.
kPDAnnotFlagNoZoom	The annotation does not zoom in or out with the rest of the document when the viewer zooms.
kPDAnnotFlagNoRotate	The annotation does not rotate when the page is rotated.
kPDAnnotFlagNoView	The annotation is not visible on the screen, but it can still be printed if the Print flag is set.
kPDAnnotFlagReadOnly	The annotation cannot be interacted with or edited by the user.
kPDAnnotFlagLocked	Prevents the annotation from being moved, resized, or otherwise modified.
kPDAnnotFlagToggleNoView	The annotation's visibility can be toggled using a script or user action.
kPDAnnotFlagLockedContents	The content of the annotation is locked, preventing changes to the annotation's content but not necessarily its position or appearance. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

PDAnnotBorderEffectStyle

enum PDAnnotBorderEffectStyle

Defines the border effect of an annotation.

For more information refer to section 12.5.4 Border styles, Table 169 — Entries in a border effect dictionary (key S), of the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDAnnotBorderEffectStyleNone	No border effect.
kPDAnnotBorderEffectStyleCloudy	It simulates the appearance of a cloud.

PDAnnotBorderType

enum PDAnnotBorderType

Defines the visual style of the borders around an annotation.

This enumeration represents the style entry in the border style dictionary.

For more information refer to section 12.5.4 Border styles, Table 168 — Entries in a border style dictionary (key S), of the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDAnnotBorderTypeSolid	A continuous, unbroken line that forms the border.
kPDAnnotBorderTypeDashed	A border composed of dashes, which can vary in length and spacing.
kPDAnnotBorderTypeBeveled	A three-dimensional effect that makes the border appear raised or inset.
kPDAnnotBorderTypeInset	Similar to beveled, but the border appears sunken or depressed into the page.
kPDAnnotBorderTypeUnderline	A simple line under the text or annotation, rather than around it.

PDAnnotHighlightMode

enum PDAnnotHighlightMode

Defines the visual representation of annotations, making it easier for users to interact with and understand a PDF document.

This enumeration specifies an annotation’s highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area.

For more information refer to section 12.5.6.19 Widget annotations, Table 191 — Additional entries specific to a widget annotation (key H) from the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDAnnotHighlightNone	No highlighting effect is applied to the annotation.
kPDAnnotHighlightInvert	The content of the annotation is inverted (e.g., black text on a white background becomes white text on a black background). This is the default.
kPDAnnotHighlightOutline	The border of the annotation is highlighted, but the content inside remains unchanged.
kPDAnnotHighlightPush	The annotation appears to be pressed or sunken into the page.
kPDAnnotHighlightToggle	The highlighting effect can be toggled on and off.

PDAnnotOperation

enum PDAnnotOperation

Defines actions or changes applied to annotations within a PDF document.

Enumerator
kPDAnnotAdded	Indicates that a new annotation has been added to the document.
kPDAnnotRemoved	Indicates that an existing annotation has been deleted from the document.
kPDAnnotChanged	Indicates that the properties or appearance of an annotation are altered.
kPDAnnotValueChanged	Indicates that main content or data of an annotation is altered.

PDAnnotState

enum PDAnnotState

Defines visual appearance of an annotation at different times based on user interaction.

Enumerator
kPDAnnotStateNormal	The default appearance of an annotation when no interaction is occurring. This is the appearance also used for printing the annotation.
kPDAnnotStateRollover	The appearance of the annotation when the user hovers the mouse over it.
kPDAnnotStateDown	The appearance of the annotation when it is being clicked or activated.

PDMarkupAnnotReplyType

enum PDMarkupAnnotReplyType

Defines the relationship between markup annotations.

This enumeration specifies the "reply type" (key RT) between an annotation and and one specified in the "in reply to" (key IRT) in the annotation dictionary specific to markup annotations. It essentially allows either a direct reply to a specific annotation or to group multiple annotations or comments together. This entry is optional and only meaningful if IRT entry present.

For more information refer to section 12.5.6.2 Markup annotations Table 172 — Additional entries in an annotation dictionary specific to markup annotations from the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDMarkupAnnotReplyReply	Allows users to respond directly to a specific annotation or comment.
kPDMarkupAnnotReplyGroup	Allows users to group multiple annotations or comments together.

PDQuadding

enum PDQuadding

Defines the alignment of text for a free text annotation.

This enumeration specifies the justification (quadding) that shall be used when displaying an annotation's text.

For more information refer to section 12.5.6.6 Free text annotation from the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDQuaddingLeft	Annotation text is left-justified.
kPDQuaddingCenter	Annotation text is centered.
kPDQuaddingRight	Annotation text is right-justified.