DL Logo

PDDoc Enumerations

AcroFormExportType

Header: DLExtrasExpT.h:542

Description

AcroForm Export Data type options.

Enum Constants

AcroFormExportTypeXFDF=1
XFDF (XML Forms Data Format) representing form field data.
AcroFormExportTypeFDF=2
FDF (Forms Data Format) representing form field data.
AcroFormExportTypeXML=3
XML (Extensible Markup Language) representing form field data.

Used By

AcroFormImportType

Header: DLExtrasExpT.h:532

Description

AcroForm Import Data type options.

Enum Constants

AcroFormImportTypeXFDF=1
XFDF (XML Forms Data Format) representing form field data.
AcroFormImportTypeFDF=2
FDF (Forms Data Format) representing form field data.
AcroFormImportTypeXML=3
XML (Extensible Markup Language) representing form field data.

Used By

PDDocFormsType

Header: DLExtrasExpT.h:553

Description

Document Forms Type options.

Enum Constants

PDDocFormsTypeNone=1
Document contains no Forms.
PDDocFormsTypeDynamicXFA=2
Document contains Dynamic XFA Forms.
PDDocFormsTypeStaticXFA=3
Document contains Static XFA Forms.
PDDocFormsTypeAcroForms=4
Document contains AcroForms.

Used By

XFAFormExportType

Header: DLExtrasExpT.h:522

Description

XFA Form Export Data type options.

Enum Constants

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

Used By

PDDoc Functions

PDDocConvertXFAFieldsToAcroFormFields

Header: DLExtrasProcs.h:1321

Description

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.

Syntax

void PDDocConvertXFAFieldsToAcroFormFields(PDDoc doc, ASUns32 *pagesConverted);

Parameters

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

PDDocExportAcroFormsData

Header: DLExtrasProcs.h:1363

Description

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

Syntax

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

Parameters

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

Returns

if True, the exporting succeeded.

PDDocExportXFAFormsData

Header: DLExtrasProcs.h:1335

Description

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

Syntax

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

Parameters

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

Returns

if True, the exporting succeeded.

PDDocFlattenAcroFormFields

Header: DLExtrasProcs.h:1309

Description

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

Syntax

void PDDocFlattenAcroFormFields(PDDoc doc);

Parameters

IN/OUT
doc The PDF document object.

PDDocFlattenNonFormAnnotations

Header: DLExtrasProcs.h:1423

Description

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

Syntax

void PDDocFlattenNonFormAnnotations(PDDoc doc);

Parameters

doc
IN/OUT The PDF document object.

PDDocFlattenXFAFields

Header: DLExtrasProcs.h:1301

Description

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.

Syntax

void PDDocFlattenXFAFields(PDDoc doc, ASUns32 *pagesOutput);

Parameters

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

PDDocFlattenXFAFieldsAsIfPrinted

Header: DLExtrasProcs.h:1413

Description

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.

Syntax

void PDDocFlattenXFAFieldsAsIfPrinted(PDDoc doc, ASUns32 *pagesOutput);

Parameters

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

PDDocGetFormsType

Header: DLExtrasProcs.h:1433

Description

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

Syntax

void PDDocGetFormsType(PDDoc doc, PDDocFormsType *formsType);

Parameters

doc
IN The PDF document object.
formsType
OUT The type of forms the document contains.

PDDocImportAcroFormsData

Header: DLExtrasProcs.h:1378

Description

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.

Syntax

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

Parameters

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

Returns

if True, the importing succeeded.

PDDocImportXFAFormsData

Header: DLExtrasProcs.h:1349

Description

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.

Syntax

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

Parameters

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

Returns

if True, the importing succeeded.

PDDocIsDynamicXFA

Header: DLExtrasProcs.h:1389

Description

Check if document is Dynamic XFA

Syntax

ASBool PDDocIsDynamicXFA(PDDoc doc);

Parameters

doc
IN The PDF document object.

Returns

if True, the document is Dynamic XFA.

PDDocIsStaticXFA

Header: DLExtrasProcs.h:1399

Description

Check if document is Static XFA

Syntax

ASBool PDDocIsStaticXFA(PDDoc doc);

Parameters

doc
IN The PDF document object.

Returns

if True, the document is Static XFA.