acroform.h File Reference

AcroForm API. More...

#include <pdfsdk/core/actions.h>
#include <pdfsdk/core/annots.h>
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/document.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>

Go to the source code of this file.

Classes
struct	PDIconFit
struct	PDSignHandler

Macros
#define	kPDChoiceNoSelection   ((size_t)(-1))
#define	kPDAutoFontSize   0.f

Typedefs
typedef struct PDFieldRec_ *	PDField
typedef void(PDFSDK_CALLCONV *	PDFieldChangedProc) (PDField field, void *clientData)
typedef uint32_t	PDFieldFlags
typedef uint32_t	PDSubmitFormFlags
typedef uint32_t	PDResetFormFlags
typedef PDErrCode(PDFSDK_CALLCONV *	PDSignGetNameProc) (void *signData, PDAtom *pName)
typedef PDErrCode(PDFSDK_CALLCONV *	PDSignGetCertDataProc) (void *signData, void *buffer, size_t bufLen, size_t *pSize)
typedef PDErrCode(PDFSDK_CALLCONV *	PDSignEstimateMaxSizeProc) (void *signData, size_t *pMaxSize)
typedef PDErrCode(PDFSDK_CALLCONV *	PDSignSignProc) (void *signData, const void *data, size_t dataLen, void *buffer, size_t bufLen, size_t *pSize)
typedef PDErrCode(PDFSDK_CALLCONV *	PDSignDestroyProc) (void *signData)

Enumerations
enum	{   kPDFieldFlagReadOnly = 0x00000001 , kPDFieldFlagRequired = 0x00000002 , kPDFieldFlagNoExport = 0x00000004 , kPDTextFieldFlagMultiline = 0x00001000 ,   kPDTextFieldFlagPassword = 0x00002000 , kPDTextFieldFlagFileSelect = 0x00100000 , kPDTextFieldFlagDoNotSpellCheck = 0x00400000 , kPDTextFieldFlagDoNotScroll = 0x00800000 ,   kPDTextFieldFlagComb = 0x01000000 , kPDTextFieldFlagRichText = 0x02000000 , kPDButtonFieldFlagNoToggleToOff = 0x00004000 , kPDButtonFieldFlagRadio = 0x00008000 ,   kPDButtonFieldFlagPushbutton = 0x00010000 , kPDButtonFieldFlagRadiosInUnison = 0x02000000 , kPDChoiceFieldFlagCombo = 0x00020000 , kPDChoiceFieldFlagEdit = 0x00040000 ,   kPDChoiceFieldFlagSort = 0x00080000 , kPDChoiceFieldFlagMultiSelect = 0x00200000 , kPDChoiceFieldFlagDoNotSpellCheck = 0x00400000 , kPDChoiceFieldFlagCommitOnSelChange = 0x04000000 }
	Defines the control, behavior and appearance of form fields. More...
enum	PDIconScaleWhen { kPDIconScaleAlways , kPDIconScaleBigger , kPDIconScaleSmaller , kPDIconScaleNever }
	Defines the circumstances under which an icon shall be scaled inside an annotation rectangle. More...
enum	PDIconScaleHow { kPDIconScaleAnamorphic , kPDIconScaleProportional }
	Defines the type of scaling that shall be used. More...
enum	PDTextPosition {   kPDTextPositionCaptionOnly = 0 , kPDTextPositionIconOnly = 1 , kPDTextPositionCaptionBelowIcon = 2 , kPDTextPositionCaptionAboveIcon = 3 ,   kPDTextPositionCaptionRight = 4 , kPDTextPositionCaptionLeft = 5 , kPDTextPositionCaptionOnIcon = 6 }
	Defines where to position the text of a widget annotation’s caption relative to its icon. More...
enum	{   kPDSubmitFormFlagExclude = 1 << 0 , kPDSubmitFormFlagIncludeNoValueFields = 1 << 1 , kPDSubmitFormFlagExportFormat = 1 << 2 , kPDSubmitFormFlagGetMethod = 1 << 3 ,   kPDSubmitFormFlagSubmitCoordinates = 1 << 4 , kPDSubmitFormFlagXFDF = 1 << 5 , kPDSubmitFormFlagIncludeAppendSaves = 1 << 6 , kPDSubmitFormFlagIncludeAnnotations = 1 << 7 ,   kPDSubmitFormFlagSubmitPDF = 1 << 8 , kPDSubmitFormFlagCanonicalFormat = 1 << 9 , kPDSubmitFormFlagExclNonUserAnnots = 1 << 10 , kPDSubmitFormFlagExclFKey = 1 << 11 ,   kPDSubmitFormFlagEmbedForm = 1 << 13 }
	Defines various behaviors of a "Submit" action for form fields in a PDF document. More...
enum	{ kPDResetFormFlagExclude = 1 << 0 }
	Controls the behavior when a reset button is used to clear or reset the form fields to their default values. More...
enum	PDSignLockPerms { kPDSignLockPermsNotSet = 0 , kPDSignLockPermsAllowNoChanges = 1 , kPDSignLockPermsAllowFormFill = 2 , kPDSignLockPermsAllowFormFillAnnotate = 3 }
	Controls the permissions and security settings of a signed PDF document. More...
enum	PDTextWidgetScrollType { kPDTextWidgetScrollNone = 0 , kPDTextWidgetScrollVertical = 1 , kPDTextWidgetScrollHorizontal = 2 }
	Defines how scroll bars are displayed and interacted with within the PDF document. More...

Functions
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetNumFields (PDDoc doc, size_t *pNumFields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetField (PDDoc doc, size_t index, PDField *pField)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocAppendField (PDDoc doc, PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocRemoveField (PDDoc doc, PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateField (PDDoc doc, const wchar_t *fullnameBuf, size_t fullnameSize, PDAtom type, PDFieldFlags flags, PDField *pField)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocFindField (PDDoc doc, const wchar_t *fullname, PDField *pField)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocRenameField (PDDoc doc, PDField field, const wchar_t *fullnameBuf, size_t fullnameSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocAttachFieldChangedCallback (PDDoc doc, PDFieldChangedProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocDetachFieldChangedCallback (PDDoc doc, PDFieldChangedProc proc, void *clientData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocNotifyFieldChanged (PDDoc doc, PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateActionFieldsData (PDDoc doc, const PDField *fields, size_t numFields, PDObject *pData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionFieldsDataGetNumFields (PDObject data, size_t *pNumFields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionFieldsDataGetField (PDObject data, size_t index, PDDoc doc, PDField *pField)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionFieldsDataAddField (PDObject data, PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSubmitFormGetServerURL (PDAction action, PDFileSpec *pFileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSubmitFormSetServerURL (PDAction action, PDFileSpec fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSubmitFormGetFieldsData (PDAction action, PDObject *pFields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSubmitFormSetFieldsData (PDAction action, PDObject fields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSubmitFormGetFlags (PDAction action, PDSubmitFormFlags *pFlags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionSubmitFormSetFlags (PDAction action, PDSubmitFormFlags flags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionResetFormGetFieldsData (PDAction action, PDObject *pFields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionResetFormSetFieldsData (PDAction action, PDObject fields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionResetFormGetFlags (PDAction action, PDResetFormFlags *pFlags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionResetFormSetFlags (PDAction action, PDResetFormFlags flags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionImportDataGetFileSpec (PDAction action, PDFileSpec *pFileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDActionImportDataSetFileSpec (PDAction action, PDFileSpec fileSpec)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCalculationOrderGetNumFields (PDDoc doc, size_t *pNumFields)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCalculationOrderGetField (PDDoc doc, size_t index, PDField *pField)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCalculationOrderInsertField (PDDoc doc, PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCalculationOrderRemoveField (PDDoc doc, PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocExportFormFDF (PDDoc doc, PDObject fields, bool exclude, const wchar_t *path)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocImportFormFDF (PDDoc doc, const wchar_t *path)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocResetForm (PDDoc doc, PDObject fields, PDResetFormFlags flags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocOpenXFAStream (PDDoc doc, PDReadStream *pStm)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetParent (PDAnnot widget, PDField *pParent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetHighlight (PDAnnot widget, PDAnnotHighlightMode highlight)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetHighlight (PDAnnot widget, PDAnnotHighlightMode *pHighlight)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetBorderStyle (PDAnnot annot, const PDAnnotBorderStyle *borderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetBorderStyle (PDAnnot annot, PDAnnotBorderStyle *pBorderStyle)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetRotate (PDAnnot annot, PDRotate rotate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetRotate (PDAnnot annot, PDRotate *pRotate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetBorderColor (PDAnnot annot, PDColorValue borderColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetBorderColor (PDAnnot annot, PDColorValue *pBorderColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetBgColor (PDAnnot annot, PDColorValue bgColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetBgColor (PDAnnot annot, PDColorValue *pBgColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotHasBgColor (PDAnnot annot, bool *has)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetFontInfo (PDAnnot widget, const PDFontInfo *fontInfo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetFontInfo (PDAnnot widget, PDFontInfo *pFontInfo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetFontColor (PDAnnot widget, PDColorValue fontColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetFontColor (PDAnnot widget, PDColorValue *pFontColor)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetFontSize (PDAnnot widget, float fontSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetFontSize (PDAnnot widget, float *pFontSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetMouseEnterAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetMouseEnterAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetMouseExitAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetMouseExitAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetMouseDownAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetMouseDownAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetMouseUpAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetMouseUpAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetFocusAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetFocusAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotSetBlurAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWidgetAnnotGetBlurAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateButtonWidgetAnnot (PDDoc doc, PDField parent, const PDRectF *rect, PDAnnot *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetCaption (PDAnnot widget, const wchar_t *captionBuf, size_t captionSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetCaption (PDAnnot widget, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetRolloverCaption (PDAnnot widget, const wchar_t *captionBuf, size_t captionSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetRolloverCaption (PDAnnot widget, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetDownCaption (PDAnnot widget, const wchar_t *captionBuf, size_t captionSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetDownCaption (PDAnnot widget, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetIcon (PDAnnot widget, PDEXObject icon)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetIcon (PDAnnot widget, PDEXObject *pIcon)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetRolloverIcon (PDAnnot widget, PDEXObject icon)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetRolloverIcon (PDAnnot widget, PDEXObject *pIcon)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetDownIcon (PDAnnot widget, PDEXObject icon)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetDownIcon (PDAnnot widget, PDEXObject *pIcon)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetIconFit (PDAnnot widget, const PDIconFit *iconFit)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetIconFit (PDAnnot widget, PDIconFit *pIconFit)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetTextPosition (PDAnnot widget, PDTextPosition textPosition)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetTextPosition (PDAnnot widget, PDTextPosition *pTextPosition)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotToggle (PDAnnot widget)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetChoice (PDAnnot widget, const wchar_t *choiceBuf, size_t choiceSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetChoice (PDAnnot widget, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetOnStateName (PDAnnot widget, PDAtom *pName)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotSetAction (PDAnnot widget, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDButtonWidgetAnnotGetAction (PDAnnot widget, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateTextWidgetAnnot (PDDoc doc, PDField parent, const PDRectF *rect, PDAnnot *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotSetTopLine (PDAnnot widget, size_t topLine)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetTopLine (PDAnnot widget, size_t *pTopLine)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotKeystroke (PDAnnot widget, size_t selStart, size_t selEnd, const wchar_t *change, size_t changeSize, bool allowOverflow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotHitTestChar (PDAnnot widget, const PDPointF *pagePt, size_t *pCharIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotSetText (PDAnnot widget, const wchar_t *text, size_t textSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetText (PDAnnot widget, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetCharQuad (PDAnnot widget, size_t index, PDQuad *pQuad)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetNumVisibleLines (PDAnnot widget, size_t *pMaxLines)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetNumLines (PDAnnot widget, size_t *pNumLines)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetFirstCharOnLine (PDAnnot widget, size_t lineIndex, size_t *pCharIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetLineWithChar (PDAnnot widget, size_t charIndex, size_t *pLineIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotDoesNeedScroll (PDAnnot widget, PDTextWidgetScrollType *pScrollType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotSetFirstVisibleChar (PDAnnot widget, size_t charIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetFirstVisibleChar (PDAnnot widget, size_t *pcharIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetNumberOfVisibleChars (PDAnnot widget, size_t *pnumOfVisibleChars)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotSetQuadding (PDAnnot widget, PDQuadding quadding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotGetQuadding (PDAnnot widget, PDQuadding *pQuadding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextWidgetAnnotHasOverflow (PDAnnot widget, bool *hasOverflow)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateChoiceWidgetAnnot (PDDoc doc, PDField parent, const PDRectF *rect, PDAnnot *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotSetTopLine (PDAnnot widget, size_t topLine)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetTopLine (PDAnnot widget, size_t *pTopLine)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotKeystroke (PDAnnot widget, size_t selStart, size_t selEnd, const wchar_t *change, size_t changeSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotHitTestChar (PDAnnot widget, const PDPointF *pagePt, size_t *pCharIndex)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotSetText (PDAnnot widget, const wchar_t *text, size_t textSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetText (PDAnnot widget, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetCharQuad (PDAnnot widget, size_t index, PDQuad *pQuad)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetNumVisibleLines (PDAnnot widget, size_t *pMaxLines)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetNumLines (PDAnnot widget, size_t *pNumLines)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetNumOptions (PDAnnot widget, size_t *pNumOptions)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotHitTestOption (PDAnnot widget, const PDPointF *pagePt, size_t *pOption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotSetSelection (PDAnnot widget, size_t option)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetSelection (PDAnnot widget, size_t *pOption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotSetQuadding (PDAnnot widget, PDQuadding quadding)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceWidgetAnnotGetQuadding (PDAnnot widget, PDQuadding *pQuadding)
PDF_CORE_API void PDFSDK_CALLCONV	PDChoiceWidgetAnnotSetGlobalSelectionColor (PDColorValue color)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateSignWidgetAnnot (PDDoc doc, PDField parent, const PDRectF *rect, PDAnnot *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignWidgetAnnotSetAppearanceParams (PDAnnot widget, PDEXObject icon, bool addCaption)
PDF_CORE_API bool PDFSDK_CALLCONV	PDFieldEqual (PDField fieldA, PDField fieldB)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetType (PDField field, PDAtom *pType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetParent (PDField field, PDField *pParent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldIsTerminal (PDField field, bool *pTerminal)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetNumChildren (PDField field, size_t *pNumChildren)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetChildByIndex (PDField field, size_t index, PDField *pChild)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldAppendChild (PDField field, PDField child)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldRemoveChild (PDField field, PDField child)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetNumWidgets (PDField field, size_t *pNumWidgets)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetWidget (PDField field, size_t index, PDAnnot *pWidget)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldAppendWidget (PDField field, PDAnnot widget)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldRemoveWidget (PDField field, PDAnnot widget)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetName (PDField field, const wchar_t *nameBuf, size_t nameSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetName (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetUIName (PDField field, const wchar_t *nameBuf, size_t nameSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetUIName (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetMappingName (PDField field, const wchar_t *nameBuf, size_t nameSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetMappingName (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetFlags (PDField field, PDFieldFlags *pFlags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetFlags (PDField field, PDFieldFlags flags)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldUpdateWidgets (PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetFullName (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetModifyAction (PDField field, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetModifyAction (PDField field, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetValidateAction (PDField field, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetValidateAction (PDField field, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetFormatAction (PDField field, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetFormatAction (PDField field, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetCalculateAction (PDField field, PDAction action)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetCalculateAction (PDField field, PDAction *pAction)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetValue (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetValue (PDField field, const wchar_t *value, size_t valueSize, PDAnnot source)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetEValue (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetEValue (PDField field, const wchar_t *value, size_t valueSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldGetDefaultValue (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDFieldSetDefaultValue (PDField field, const wchar_t *value, size_t valueSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateButtonField (PDDoc doc, PDField parent, PDFieldFlags flags, PDField *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateTextField (PDDoc doc, PDField parent, PDFieldFlags flags, PDField *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextFieldSetMaxLen (PDField field, size_t maxlen)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDTextFieldGetMaxLen (PDField field, size_t *pMaxLen)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateChoiceField (PDDoc doc, PDField parent, PDFieldFlags flags, PDField *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldGetNumOptions (PDField field, size_t *pNumOptions)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldFindOptionByValue (PDField field, const wchar_t *value, size_t valueSize, size_t *pOption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldFindOptionByExportValue (PDField field, const wchar_t *exportValue, size_t exportValueSize, size_t *pOption)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldGetOptionValue (PDField field, size_t option, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldGetOptionExportValue (PDField field, size_t option, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldInsertOption (PDField field, size_t index, const wchar_t *value, size_t valueSize, const wchar_t *exportValue, size_t exportValueSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldRemoveOption (PDField field, size_t index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDChoiceFieldRemoveAllOptions (PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateSignField (PDDoc doc, PDField parent, PDFieldFlags flags, PDField *pOut)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocIsSigned (PDDoc doc, bool *pSigned)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocHasURPerms (PDDoc doc, bool *pHasURPerms)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldIsBlank (PDField field, bool *pBlank)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldSetLock (PDField field, PDAtom action, PDObject fields, PDSignLockPerms perms)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldGetLock (PDField field, PDAtom *action, PDObject *fields, PDSignLockPerms *perms)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldSign (PDField field, const PDSignHandler *signHandler, void *signData, const wchar_t *reason)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldAuthorSign (PDField field, PDSignLockPerms perms, const PDSignHandler *signHandler, void *signData, const wchar_t *reason)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldClear (PDField field)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldVerify (PDField field, bool *pValid)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldDocModifiedAfterSign (PDField field, bool *pModified)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldGetReason (PDField field, wchar_t *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldGetSigningDate (PDField field, PDDateTime *pDate)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldGetCertificate (PDField field, void *buffer, size_t bufSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldGetRevision (PDField field, int *pRevision)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDSignFieldSaveSignedVersion (PDField field, const wchar_t *filename)

Detailed Description

AcroForm API.

Enumeration Type Documentation

anonymous enum

anonymous enum

Defines the control, behavior and appearance of form fields.

This enumeration specifies how data is handled by form fields, making sure that the form behaves as expected and that the data collected is complete and accurate.

Enumerator
kPDFieldFlagReadOnly	This flag makes the form field non-editable.
kPDFieldFlagRequired	This flag indicates that the form field must be filled out before the form can be submitted.
kPDFieldFlagNoExport	This flag prevents the form field's data from being exported when the form data is submitted.
kPDTextFieldFlagMultiline	Allows the text field to accept multiple lines of text.
kPDTextFieldFlagPassword	Masks the input text for privacy, showing asterisks or dots instead of the actual characters.
kPDTextFieldFlagFileSelect	Allows the text field to accept file paths by enabling a file selection dialog.
kPDTextFieldFlagDoNotSpellCheck	Disables the spellcheck feature for the text field.
kPDTextFieldFlagDoNotScroll	Prevents the text field from scrolling when the text exceeds the field's visible area.
kPDTextFieldFlagComb	Splits the text field into separate smaller fields of equal size, useful for formatted inputs like dates or phone numbers.
kPDTextFieldFlagRichText	Allows the text field to support rich text formatting, including different fonts, styles, colors, and other text attributes.
kPDButtonFieldFlagNoToggleToOff	Prevents a button from being toggled off once it is selected. This ensures that at least one button remains selected at all times.
kPDButtonFieldFlagRadio	Indicates that the button is part of a group of mutually exclusive options. Only one button in the group can be selected at a time.
kPDButtonFieldFlagPushbutton	Specifies that the button is a standard push button, which can be clicked to trigger an action such as submitting a form or resetting fields.
kPDButtonFieldFlagRadiosInUnison	Ensures that a group of radio buttons behaves in unison. Selecting a button in one group also selects the corresponding button in another group.
kPDChoiceFieldFlagCombo	Indicates that the choice field should combine multiple selections into a single display string.
kPDChoiceFieldFlagEdit	Allows the user to enter custom text in addition to selecting from predefined options.
kPDChoiceFieldFlagSort	Automatically sorts the items in the choice field in alphabetical order.
kPDChoiceFieldFlagMultiSelect	Allows users to select multiple items from the list.
kPDChoiceFieldFlagDoNotSpellCheck	Disables spellchecking for the text entered in the choice field.
kPDChoiceFieldFlagCommitOnSelChange	Triggers an action immediately when the user makes a selection.

anonymous enum

anonymous enum

Defines various behaviors of a "Submit" action for form fields in a PDF document.

For more information you can refer to section 12.7.6.2 Submit-form Action, located in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDSubmitFormFlagExclude	Specifies whether to include (bit not set) or exclude (bit set) form fields for submission. The Fields array specifies which fields.
kPDSubmitFormFlagIncludeNoValueFields	If clear, fields without a value shall not be submitted. If set all fields designated by the Fields array and the Exclude flag shall be submitted.
kPDSubmitFormFlagExportFormat	If clear, field names and values will be submitted in Forms Data Format(FDF). If set they will be submitted in HTML format. Meaningful only if SubmitPDF and XFDF are not set.
kPDSubmitFormFlagGetMethod	If set, field names and values shall be submitted using an HTTP GET request. If clear, they shall be submitted using a POST request. If ExportFormat is clear, this flag shall also be clear. This flag is meaningful only when the ExportFormat flag is set.
kPDSubmitFormFlagSubmitCoordinates	If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. This flag shall be used only when the ExportFormat flag is set. If ExportFormat is clear, this flag shall also be clear.
kPDSubmitFormFlagXFDF	If set, field names and values shall be submitted as XFDF. It shall be used only if the SubmitPDF flags are clear.
kPDSubmitFormFlagIncludeAppendSaves	If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document. If clear, the incremental updates shall not be included. Shall be used only when the form is being submitted in Forms Data Format (i.e. when both the XFDF and ExportFormat flags are clear).
kPDSubmitFormFlagIncludeAnnotations	If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document. If clear, markup annotations shall not be included. Shall be used only when the form is being submitted in Forms Data Format (when both the XFDF and ExportFormat flags are clear).
kPDSubmitFormFlagSubmitPDF	If set, the document shall be submitted as PDF. If set, all other flags shall be ignored except GetMethod.
kPDSubmitFormFlagCanonicalFormat	If set, any submitted field values representing dates shall be converted to the standard format described in 7.9.4 Dates located in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.
kPDSubmitFormFlagExclNonUserAnnots	Excludes markup annotations (such as comments, highlights, and sticky notes) that were not created by the current user.
kPDSubmitFormFlagExclFKey	Excludes the F entry (field names and values) from the submitted data. Shall be used only when the form is being submitted in Forms Data Format. (when both the XFDF and ExportFormat flags are clear).
kPDSubmitFormFlagEmbedForm	This flag ensures that the form data is embedded directly within the PDF document, rather than being submitted as a separate data file. It shall be used only when the form is being submitted in Forms Data Format (when both the XFDF and ExportFormat flags are clear).

anonymous enum

anonymous enum

Controls the behavior when a reset button is used to clear or reset the form fields to their default values.

If clear, the Fields array specifies which fields to reset. If set, the Fields array indicates which fields to exclude from resetting. For information on the Fields array you can refer to section 12.7.6.3 Reset-form Action, table 241 - Additional entries specific to a reset-form action found in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

PDIconScaleHow

enum PDIconScaleHow

Defines the type of scaling that shall be used.

For more information you can refer to section 12.7.8.3.2 FDF Fields, table 250 Entries in an icon fit dictionary, Key S located in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDIconScaleAnamorphic	Scale the icon to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height).
kPDIconScaleProportional	Scale the icon to fit the width or height of the annotation rectangle while maintaining the icon’s original aspect ratio.

PDIconScaleWhen

enum PDIconScaleWhen

Defines the circumstances under which an icon shall be scaled inside an annotation rectangle.

For more information you can refer to section 12.7.8.3.2 FDF Fields, table 250 Entries in an icon fit dictionary, Key SW located in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDIconScaleAlways	Always scale the icon. This is the default value.
kPDIconScaleBigger	Scale only when the icon is bigger than the annotation rectangle.
kPDIconScaleSmaller	Scale only when the icon is smaller than the annotation rectangle.
kPDIconScaleNever	Never scale the icon.

PDSignLockPerms

enum PDSignLockPerms

Controls the permissions and security settings of a signed PDF document.

Enumerator
kPDSignLockPermsNotSet	Applies the default permissions as set by the PDF processor or document creator.
kPDSignLockPermsAllowNoChanges	Denies all permissions, making the document fully locked and read-only after it has been signed.
kPDSignLockPermsAllowFormFill	Allows users to fill out forms within the PDF even after it has been signed.
kPDSignLockPermsAllowFormFillAnnotate	Permits both form filling and editing of the document after it has been signed.

PDTextPosition

enum PDTextPosition

Defines where to position the text of a widget annotation’s caption relative to its icon.

For more information you can refer to section 12.5.6.19 Widget Annotations, table 192 - Entries in an appearance characteristics dictionary, Key TP, located in the ISO 32000-2:2020 (PDF 2.0) PDF Standard.

Enumerator
kPDTextPositionCaptionOnly	No icon, caption only.
kPDTextPositionIconOnly	No caption, icon only.
kPDTextPositionCaptionBelowIcon	Caption below the icon.
kPDTextPositionCaptionAboveIcon	Caption above the icon.
kPDTextPositionCaptionRight	Caption to the right of the icon.
kPDTextPositionCaptionLeft	Caption to the left of the icon.
kPDTextPositionCaptionOnIcon	Caption overlaid directly on the icon.

PDTextWidgetScrollType

enum PDTextWidgetScrollType

Defines how scroll bars are displayed and interacted with within the PDF document.

Enumerator
kPDTextWidgetScrollNone	No scroll bars are displayed.
kPDTextWidgetScrollVertical	Only vertical scroll bars are displayed.
kPDTextWidgetScrollHorizontal	Only horizontal scroll bars are displayed.