Options

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
Line 15: Line 15:
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
 
| Array of <tt>'''String'''</tt>
 
| Array of <tt>'''String'''</tt>
Specifies...
+
Specifies an array of field names to submit or a string containing a single field name.
 
|-
 
|-
 
| class="op_param_name" | Exclude
 
| class="op_param_name" | Exclude
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| 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: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| class="op_param_name" | URL
 
| class="op_param_name" | URL
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the URL to submit to.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | SubmitAs
 
| class="op_param_name" | SubmitAs
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies this parameter indicates the format for submission. Values are:
Default value: <tt>'''0'''</tt>
+
 
 +
{| class="op_internal_table"
 +
|-
 +
| class="op_enum_value" | '''0''' (FDF) ||Submit as FDF
 +
|-
 +
| class="op_enum_value" | '''1''' (XFDF) ||Submit as XFDF
 +
|-
 +
| class="op_enum_value" | '''2''' (HTML) ||Submit as HTML
 +
|-
 +
| class="op_enum_value" | '''4''' (XDP) ||Submit as XDP
 +
|-
 +
| class="op_enum_value" | '''5''' (XML) ||Submit as XML.  
 +
|-
 +
| class="op_enum_value" | '''6''' (XFD) ||Submit as Form Client Data File
 +
|-
 +
| class="op_enum_value" | '''3''' (PDF) ||Submit the complete PDF document
 +
|}
 +
 
 +
Default value: <tt>'''0''' (FDF)</tt>
 
|-
 
|-
 
| class="op_param_name" | Packets
 
| class="op_param_name" | Packets
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| 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:
Default value: <tt>'''34'''</tt>
+
{| class="op_internal_table"
 +
|-
 +
| class="op_enum_value" | '''0x001''' ||config
 +
|-
 +
| class="op_enum_value" | '''0x002''' ||datasets
 +
|-
 +
| class="op_enum_value" | '''0x040''' ||sourceSet
 +
|-
 +
| class="op_enum_value" | '''0x004''' ||stylesheet
 +
|-
 +
| class="op_enum_value" | '''0x008''' ||template
 +
|-
 +
| class="op_enum_value" | '''0x010''' ||pdf — The PDF should be embedded; if pdf is not included, only a link to the PDF is included in the XDP.
 +
|-
 +
| class="op_enum_value" | '''0x020''' ||xfdf — Include annotations in the XDP (since that packet uses XFDF format)
 +
|-
 +
| class="op_enum_value" | '''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: <tt>'''34''' (datasets | xfdf)</tt>
 
|-
 
|-
 
| class="op_param_name" | Flags
 
| class="op_param_name" | Flags
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies where from the flag operation.
 +
The list of possible values are shown in [[PXV:PXC_SubmitFormActionFlags | PXC_SubmitFormActionFlags]]
 +
 
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | DocPermID
 
| class="op_param_name" | DocPermID
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a permanent ID to assign to the PDF that is submitted.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | DocInstID
 
| class="op_param_name" | DocInstID
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies an instance ID to assign to the PDF that is submitted.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | FDFScriptBefore
 
| class="op_param_name" | FDFScriptBefore
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies can be used to include Before scripts in a submitted FDF file.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | FDFScriptAfter
 
| class="op_param_name" | FDFScriptAfter
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies can be used to include After scripts in a submitted FDF file.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
Line 65: Line 103:
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
 
| Array of <tt>'''[[#FDFScriptDoc|Dictionary]]'''</tt>
 
| Array of <tt>'''[[#FDFScriptDoc|Dictionary]]'''</tt>
Specifies...
+
Specifies can be used to include Doc scripts in a submitted FDF file.
 
|}
 
|}
  
Line 77: Line 115:
 
| class="op_param_name" | Name
 
| class="op_param_name" | Name
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies name of the new JavaScript array entry.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Script
 
| class="op_param_name" | Script
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies script of the new JavaScript array entry.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|}
 
|}

Latest revision as of 02:58, 15 March 2016


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