Layer

Forms Extension

2 components19 items

14 Functions 1 Structures 4 Enums

General

3 items

Functions(2)

GetFormsExtensionVersionNumber

void GetFormsExtensionVersionNumber(FormsExtensionVersion version)

DLExtrasProcs.h:1425

Retrieves the Forms Extension Version Number.

Parameters

version: FormsExtensionVersion: OUT - Structure that holds the version number sub-components.

Returns

void

IsFormsExtensionSupported

ASBool IsFormsExtensionSupported(void)

DLExtrasProcs.h:1276

Validate the Forms Extension for APDFL dependencies are present.

Parameters

: void

Returns

ASBool

Structures(1)

FormsExtensionVersion

typedef struct FormsExtensionVersionRec * FormsExtensionVersion

DLExtrasExpT.h:572

PDDoc

16 items

Functions(12)

PDDocConvertXFAFieldsToAcroFormFields

void PDDocConvertXFAFieldsToAcroFormFields(PDDoc doc, ASUns32 *pagesConverted)

DLExtrasProcs.h:1308

Convert a XFA document into a document with only AcroForms. XFA content is not widely supported by PDF processors, converting this content transforms XFA fields into AcroForm fields which are more widely supported by PDF processors. All XFA fields are removed.

Parameters

doc: PDDoc: IN/OUT The PDF document object.
pagesConverted: ASUns32 *: OUT The number of output pages created in the converted document.

Returns

void

PDDocExportAcroFormsData

ASBool PDDocExportAcroFormsData(PDDoc doc, ASFileSys fileSys, ASPathName pathName, AcroFormExportType acroFormExportType)

DLExtrasProcs.h:1349

Export the AcroForms data. AcroForms data is exported to a format that can later be imported into another AcroForms document.

Parameters

doc: PDDoc: IN The PDF document object.
fileSys: ASFileSys: IN The file system to write the data to (May be NULL, in which case the default file system will be used)
pathName: ASPathName: OUT The path on disk of the file the AcroForms data is exported to.
acroFormExportType: AcroFormExportType: IN The format type the AcroForm data should be exported to. The supported types are XFDF, FDF, and XML.

Returns

ASBool

PDDocExportXFAFormsData

ASBool PDDocExportXFAFormsData(PDDoc doc, ASFileSys fileSys, ASPathName pathName, XFAFormExportType exportType)

DLExtrasProcs.h:1322

Export the XFA Forms data. XFA forms data is exported to a format that can later be imported into another XFA document.

Parameters

doc: PDDoc: IN The PDF document object.
fileSys: ASFileSys: IN The file system to write the document to (May be NULL, in which case the default file system will be used)
pathName: ASPathName: OUT The path on disk of the file the XFA form data is exported to.
exportType: XFAFormExportType: IN The format type the XFA data should be exported to. The supported types are XDP, XML, and XFD.

Returns

ASBool

PDDocFlattenAcroFormFields

void PDDocFlattenAcroFormFields(PDDoc doc)

DLExtrasProcs.h:1296

Flatten an AcroForms document. Interactive AcroForm fields are flattened into static PDF page content. All AcroForm fields are removed.

Parameters

doc: PDDoc

Returns

void

PDDocFlattenNonFormAnnotations

void PDDocFlattenNonFormAnnotations(PDDoc doc)

DLExtrasProcs.h:1407

Flatten a Non-Form (no AcroForm, no XFA) document's Annotations. Annotations are flattened into static PDF page content.

Parameters

doc: PDDoc: IN/OUT The PDF document object.

Returns

void

PDDocFlattenXFAFields

void PDDocFlattenXFAFields(PDDoc doc, ASUns32 *pagesOutput)

DLExtrasProcs.h:1288

Flatten a XFA Document (Static or Dynamic). XFA content is not widely supported by PDF processors. Flattening this content transforms into static PDF page content that is part of typical PDF files that can easily be understood by PDF processors. All XFA fields are removed.

Parameters

doc: PDDoc: IN/OUT The PDF document object.
pagesOutput: ASUns32 *

Returns

void

PDDocFlattenXFAFieldsAsIfPrinted

void PDDocFlattenXFAFieldsAsIfPrinted(PDDoc doc, ASUns32 *pagesOutput)

DLExtrasProcs.h:1397

Flatten a XFA Document (Static or Dynamic) as if printed. XFA content is not widely supported by PDF processors. Flattening this content transforms into static PDF page content that is part of typical PDF files that can easily be understood by PDF processors. All XFA fields are removed. The Flattened appearance will take into consideration how the document's appearance should appear when printed.

Parameters

doc: PDDoc: IN/OUT The PDF document object.
pagesOutput: ASUns32 *: OUT The number of output pages created in the flattened document.

Returns

void

PDDocGetFormsType

void PDDocGetFormsType(PDDoc doc, PDDocFormsType *formsType)

DLExtrasProcs.h:1417

Returns the document's Forms Type. This method is more versatile than the related PDDocIsDynamicXFA() and PDDocIsStaticXFA() methods.

Parameters

doc: PDDoc: IN The PDF document object.
formsType: PDDocFormsType *: OUT The type of forms the document contains.

Returns

void

PDDocImportAcroFormsData

ASBool PDDocImportAcroFormsData(PDDoc doc, ASFileSys fileSys, ASPathName pathName, AcroFormImportType acroFormImportType)

DLExtrasProcs.h:1363

Import the AcroForms data. AcroForms data is imported from a supported format into the AcroForms document so its existing fields can be populated for example.

Parameters

doc: PDDoc: IN/OUT The PDF document object.
fileSys: ASFileSys: IN The file system to import the data from (May be NULL, in which case the default file system will be used)
pathName: ASPathName: IN The path on disk of the AcroFormsdata file to be imported.
acroFormImportType: AcroFormImportType: IN The format type the data type should be imported to. The supported types are XFDF, FDF, and XML.

Returns

ASBool

PDDocImportXFAFormsData

ASBool PDDocImportXFAFormsData(PDDoc doc, ASFileSys fileSys, ASPathName pathName)

DLExtrasProcs.h:1335

Import the XFA Forms data. XFA forms data is imported from a supported format into the XFA document so its existing fields can be populated for example.

Parameters

doc: PDDoc: IN/OUT The PDF document object.
fileSys: ASFileSys: IN The file system to import the document from (May be NULL, in which case the default file system will be used)
pathName: ASPathName: IN The path on disk of the XFA form data file to be imported. The supported types are XDP, XML, and XFD.

Returns

ASBool

PDDocIsDynamicXFA

ASBool PDDocIsDynamicXFA(PDDoc doc)

DLExtrasProcs.h:1373

Check if document is Dynamic XFA

Parameters

doc: PDDoc: IN The PDF document object.

Returns

ASBool

PDDocIsStaticXFA

ASBool PDDocIsStaticXFA(PDDoc doc)

DLExtrasProcs.h:1383

Check if document is Static XFA

Parameters

doc: PDDoc: IN The PDF document object.

Returns

ASBool

Enums(4)

AcroFormExportType

DLExtrasExpT.h:542

AcroForm Export Data type options.

Values

AcroFormExportTypeXFDF: XFDF (XML Forms Data Format) representing form field data.
AcroFormExportTypeFDF: FDF (Forms Data Format) representing form field data.
AcroFormExportTypeXML: XML (Extensible Markup Language) representing form field data.

AcroFormImportType

DLExtrasExpT.h:532

AcroForm Import Data type options.

Values

AcroFormImportTypeXFDF: XFDF (XML Forms Data Format) representing form field data.
AcroFormImportTypeFDF: FDF (Forms Data Format) representing form field data.
AcroFormImportTypeXML: XML (Extensible Markup Language) representing form field data.

PDDocFormsType

DLExtrasExpT.h:553

Document Forms Type options.

Values

PDDocFormsTypeNone: Document contains no Forms.
PDDocFormsTypeDynamicXFA: Document contains Dynamic XFA Forms.
PDDocFormsTypeStaticXFA: Document contains Static XFA Forms.
PDDocFormsTypeAcroForms: Document contains AcroForms.

XFAFormExportType

DLExtrasExpT.h:522

XFA Form Export Data type options.

Values

XFAFormExportTypeXML: XML (Extensible Markup Language) representing form field data.
XFAFormExportTypeXFD: XFD (Extensible Forms Description language) representing form field data.
XFAFormExportTypeXDP: XDP (XML Data Package) representing form field data.