Forms
115 functions. Every declaration on the detail pages is extracted from the shipped bindings.
Core
pdfDeleteAcroForm
|
Remove the entire AcroForm — every field, the /AcroForm |
|---|---|
pdfDeleteField
|
Delete a field — by handle or by name. |
pdfDeleteFieldEx
|
Delete a field — by handle or by name. |
pdfDeleteXFAForm
|
Drop every authored XFA packet (from pdfCreateXFAStream, |
pdfFindField
|
Look up a field's document-wide handle by its fully- |
pdfFlattenForm
|
Flatten every form field in the document (bake current |
pdfReadImageFormat
|
Read an image file's geometry (dimensions, effective |
pdfReadImageFormat2
|
Same inspection as pdfReadImageFormat, but for a specific |
pdfReadImageFormatEx
|
Read geometry from an in-memory Windows GDI bitmap handle |
pdfReadImageFormatFromBuffer
|
Same inspection as pdfReadImageFormat, but decoding an |
pdfRemoveFormFieldChoiceSub
|
Remove a Choice-field /Opt entry by its export-value name |
pdfRenderXFAForm
|
Drive the XFA dynamic-form engine explicitly: render the |
pdfSortFieldsByIndex
|
Get/set a field's position in the AcroForm /Fields array |
pdfSortFieldsByName
|
Get/set a field's position in the AcroForm /Fields array |
pdfXFAFormPageCount
|
Drive the XFA dynamic-form engine explicitly: render the |
Forms
pdfGetField
|
Read a field's full metadata by document-wide handle |
|---|---|
pdfGetFieldBackColor
|
Set/get the /MK /BG (background), /MK /BC (border), and |
pdfGetFieldBorderColor
|
Set/get the /MK /BG (background), /MK /BC (border), and |
pdfGetFieldBorderStyle
|
Get/set a specific field's /BS /S border style and /BS |
pdfGetFieldBorderWidth
|
Get/set a specific field's /BS /S border style and /BS |
pdfGetFieldCalcOrder
|
Read/reorder the AcroForm /CO calculation-order array — |
pdfGetFieldChoiceValue
|
Read one /Opt entry (export value + display value pair) |
pdfGetFieldColor
|
Get/set any field's background/border/text color by |
pdfGetFieldCount
|
Read a field's full metadata by document-wide handle |
pdfGetFieldEx
|
Read a field's full metadata by document-wide handle |
pdfGetFieldEx2
|
Read a field's full metadata by document-wide handle |
pdfGetFieldExpValCount
|
pdfGetFieldExpValue reads the checkbox/radio-button |
pdfGetFieldExpValue
|
pdfGetFieldExpValue reads the checkbox/radio-button |
pdfGetFieldExpValueEx
|
pdfGetFieldExpValue reads the checkbox/radio-button |
pdfGetFieldFlags
|
Get/set the field's /Ff flags bitmask (ReadOnly/Required/ |
pdfGetFieldGroupType
|
Return a field's TFieldType ordinal (Text/Button/Choice/ |
pdfGetFieldHighlightMode
|
Get/set a field's /H mouse-down highlight mode — the |
pdfGetFieldIndex
|
Get/set a field's position in the AcroForm /Fields array |
pdfGetFieldMapName
|
Get/set a field's /TM alternate mapping name — used by |
pdfGetFieldName
|
Get/set a field's partial name (/T) — the segment |
pdfGetFieldOrientation
|
Get/set a field widget's /MK /R rotation. |
pdfGetFieldTextAlign
|
Get/set a field's /Q text justification (Left/Center/ |
pdfGetFieldTextColor
|
Set/get the /MK /BG (background), /MK /BC (border), and |
pdfGetFieldToolTip
|
Get/set a field's /TU tooltip (alternate description) |
pdfGetFieldType
|
Return a field's TFieldType ordinal (Text/Button/Choice/ |
pdfSetFieldBackColor
|
Set/get the /MK /BG (background), /MK /BC (border), and |
pdfSetFieldBBox
|
Reposition/resize a field's /Rect. |
pdfSetFieldBorderColor
|
Set/get the /MK /BG (background), /MK /BC (border), and |
pdfSetFieldBorderStyle
|
Get/set a specific field's /BS /S border style and /BS |
pdfSetFieldBorderWidth
|
Get/set a specific field's /BS /S border style and /BS |
pdfSetFieldCalcOrder
|
Read/reorder the AcroForm /CO calculation-order array — |
pdfSetFieldColor
|
Get/set any field's background/border/text color by |
pdfSetFieldExpValue
|
Add a Choice-field /Opt entry (export value + display |
pdfSetFieldExpValueEx
|
Add a Choice-field /Opt entry (export value + display |
pdfSetFieldFlags
|
Get/set the field's /Ff flags bitmask (ReadOnly/Required/ |
pdfSetFieldHighlightMode
|
Get/set a field's /H mouse-down highlight mode — the |
pdfSetFieldIndex
|
Get/set a field's position in the AcroForm /Fields array |
pdfSetFieldMapName
|
Get/set a field's /TM alternate mapping name — used by |
pdfSetFieldName
|
Get/set a field's partial name (/T) — the segment |
pdfSetFieldOrientation
|
Get/set a field widget's /MK /R rotation. |
pdfSetFieldTextAlign
|
Get/set a field's /Q text justification (Left/Center/ |
pdfSetFieldTextColor
|
Set/get the /MK /BG (background), /MK /BC (border), and |
pdfSetFieldToolTip
|
Get/set a field's /TU tooltip (alternate description) |
Getters
pdfGetCheckBoxChar
|
Set/get the document-global default ZapfDingbats |
|---|---|
pdfGetCheckBoxCharEx
|
Set/get the document-global default ZapfDingbats |
pdfGetCheckBoxDefState
|
Get/set a checkbox's /DV default checked state |
pdfGetFormFieldCaption
|
Read a button/widget field's /MK /CA (normal caption) — |
pdfGetFormFieldCaptionEx
|
Read a button/widget field's /MK /CA (normal caption) — |
pdfGetFormFieldRichTextString
|
Get/set an arbitrary named string-valued key on a rich-text |
pdfGetFullyQualifiedFieldName
|
Return a field's full dotted-path name (e.g. |
pdfGetInFieldCount
|
Return the field count in the currently open import |
pdfGetInIsXFAForm
|
Report whether the currently open import source |
pdfGetJSFields
|
Retrieve the fields-JSON output produced by the SDK's most |
pdfGetMaxFieldLen
|
Get/set a text field's /MaxLen character limit. |
pdfGetNumberFormatObj
|
Nominally: resolve a built-in numeric-format-object handle |
pdfGetPageField
|
Enumerate the fields whose widget annotation is placed on |
pdfGetPageFieldCount
|
Enumerate the fields whose widget annotation is placed on |
pdfGetPageFieldEx
|
Enumerate the fields whose widget annotation is placed on |
pdfGetSaveNewImageFormat
|
Get/set the document-wide policy flag controlling whether |
pdfGetTextFieldValue
|
Read a text field's current (/V) and default (/DV) |
pdfGetXFAFormFieldAccess
|
Get/set a template <field>'s access attribute (XFA's |
pdfGetXFAFormFieldBorderColor
|
Get/set a template field's border/edge/color value — |
pdfGetXFAFormFieldBorderPresence
|
Get/set a template field's border/edge presence |
pdfGetXFAFormFieldBorderWidth
|
Get/set a template field's border/edge thickness |
pdfGetXFAFormFieldCount
|
Enumerate the leaf field names present in the XFA |
pdfGetXFAFormFieldName
|
Enumerate the leaf field names present in the XFA |
pdfGetXFAFormFieldNames
|
Enumerate the leaf field names present in the XFA |
pdfGetXFAFormFieldValue
|
Get/set a datasets leaf's text value, addressed by |
pdfGetXFALastError
|
Drive the XFA dynamic-form engine explicitly: render the |
Object Creation
pdfCreateBarcodeField
|
Create a barcode-bearing widget field — a form field whose |
|---|---|
pdfCreateCheckBox
|
Create a checkbox or radio-button (/FT /Btn) field with a |
pdfCreateCollectionField
|
Define a schema column (/Schema entry) for a PDF Portable |
pdfCreateComboBox
|
Create a Choice-type field (/FT /Ch) — combo box |
pdfCreateGroupField
|
Create a non-terminal field-tree grouping node (/T with |
pdfCreateListBox
|
Create a Choice-type field (/FT /Ch) — combo box |
pdfCreateRadioButton
|
Create a checkbox or radio-button (/FT /Btn) field with a |
pdfCreateTextField
|
Create a text (/FT /Tx) form field. |
Setters
pdfSetCatalogInformation
|
Add or overwrite an arbitrary named entry directly under |
|---|---|
pdfSetCheckBoxChar
|
Set/get the document-global default ZapfDingbats |
pdfSetCheckBoxDefState
|
Get/set a checkbox's /DV default checked state |
pdfSetCheckBoxState
|
Get/set a checkbox's /DV default checked state |
pdfSetColSortField
|
Choose which portable-collection (PDF Package/Portfolio) |
pdfSetDateTimeFormat
|
Give a text field Acrobat-standard date/time input |
pdfSetFormFieldPage
|
Move a field's widget annotation to a different page — |
pdfSetFormFieldRichTextString
|
Get/set an arbitrary named string-valued key on a rich-text |
pdfSetMaxFieldLen
|
Get/set a text field's /MaxLen character limit. |
pdfSetNumberFormat
|
Give a text field Acrobat-standard numeric input formatting |
pdfSetPageFormat
|
Set the pending page size from a table of 28 standard DIN |
pdfSetSaveNewImageFormat
|
Get/set the document-wide policy flag controlling whether |
pdfSetTextFieldValue
|
Set a text field's /V value. |
pdfSetTextFieldValueEx
|
Set a text field's /V value. |
pdfSetXFAExpandMode
|
Drive the XFA dynamic-form engine explicitly: render the |
pdfSetXFAFormFieldAccess
|
Get/set a template <field>'s access attribute (XFA's |
pdfSetXFAFormFieldBorderColor
|
Get/set a template field's border/edge/color value — |
pdfSetXFAFormFieldBorderPresence
|
Get/set a template field's border/edge presence |
pdfSetXFAFormFieldBorderWidth
|
Get/set a template field's border/edge thickness |
pdfSetXFAFormFieldValue
|
Get/set a datasets leaf's text value, addressed by |
pdfSetXFARenderMode
|
Drive the XFA dynamic-form engine explicitly: render the |
pdfSetXFAScriptEnabled
|
Drive the XFA dynamic-form engine explicitly: render the |
Validation
pdfCheckFieldNames
|
Validate the document's field-name structure (e.g. |
|---|