Options

From Tracker Software PDF SDK
Revision as of 02:58, 15 March 2016 by Oliynykd (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Options Table

Name Type Value
Fields Array Array of String

Specifies an array of field names to submit or a string containing a single field name.

Exclude Boolean Specifies the exclude value. If Exclude has a value of false, that array defines a list of fields that should be excluded from all fields list before resetting.

Default value: false

URL String Specifies the URL to submit to.

Default value: Empty String

SubmitAs Integer Specifies this parameter indicates the format for submission. Values are:
0 (FDF) Submit as FDF
1 (XFDF) Submit as XFDF
2 (HTML) Submit as HTML
4 (XDP) Submit as XDP
5 (XML) Submit as XML.
6 (XFD) Submit as Form Client Data File
3 (PDF) Submit the complete PDF document

Default value: 0 (FDF)

Packets Integer An array of strings, specifying which packets to include in an XDP submission. This parameter is only applicable if SubmitAs is XDP. Possible strings are:
0x001 config
0x002 datasets
0x040 sourceSet
0x004 stylesheet
0x008 template
0x010 pdf — The PDF should be embedded; if pdf is not included, only a link to the PDF is included in the XDP.
0x020 xfdf — Include annotations in the XDP (since that packet uses XFDF format)
0xFFF * — All packets should be included in the XDP. The default for pdf is to include it as a reference. To embed the PDF file in the XDP, explicitly specify pdf as one of the packets.

Default value: 34 (datasets | xfdf)

Flags Integer Specifies where from the flag operation.

The list of possible values are shown in PXC_SubmitFormActionFlags

Default value: 0

DocPermID String Specifies a permanent ID to assign to the PDF that is submitted.

Default value: Empty String

DocInstID String Specifies an instance ID to assign to the PDF that is submitted.

Default value: Empty String

FDFScriptBefore String Specifies can be used to include Before scripts in a submitted FDF file.

Default value: Empty String

FDFScriptAfter String Specifies can be used to include After scripts in a submitted FDF file.

Default value: Empty String

FDFScriptDoc Array Array of Dictionary

Specifies can be used to include Doc scripts in a submitted FDF file.

FDFScriptDoc Table

Name Type Value
Name String Specifies name of the new JavaScript array entry.

Default value: Empty String

Script String Specifies script of the new JavaScript array entry.

Default value: Empty String