Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Options Table)
(Label ToWrite removed)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_document_exportCommentsAndFields|Options|property}}
 
{{#parentPage:PXV:op_document_exportCommentsAndFields|Options|property}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 34: Line 34:
 
| class="op_param_name" | cHRef
 
| class="op_param_name" | cHRef
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a device independent path that would be displayed in the resulting file. If empty - the document's path will be used.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
Line 44: Line 44:
 
| class="op_param_name" | ExcludePassword
 
| class="op_param_name" | ExcludePassword
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Specifies whether the text fields with password flag will be exported.
 
Default value: <tt>'''true'''</tt>
 
Default value: <tt>'''true'''</tt>
 
|-
 
|-
 
| class="op_param_name" | ExportFieldFlags
 
| class="op_param_name" | ExportFieldFlags
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Specifies whether the field flags should be exported.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
Line 55: Line 55:
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
 
| Array of <tt>'''String'''</tt>
 
| Array of <tt>'''String'''</tt>
Specifies...
+
Specifies the names of the fields that should be exported.
 
|-
 
|-
 
| class="op_param_name" | DestFile
 
| class="op_param_name" | DestFile
 
| style="text-align:center" | IUnknown
 
| style="text-align:center" | IUnknown
| Specifies...
+
| Specifies the destination file into which the comments and fields will be exported. Can be [[PXV:IAFS_Name|IAFS_Name]], [[PXV:IAFS_File|IAFS_File]] or [[PXV:IStream|IStream]].
 
|}
 
|}

Latest revision as of 23:23, 23 June 2016


Options Table

Name Type Value
FileName String Specifies the name of the resulting file.

Default value: Empty String

Format String Specifies the resulting file format (FDF, XFDF, XML or Text).

Default value: FDF

ExportAnnots Boolean Specifies whether the annotations need to be exported.

Default value: false

ExportFields Boolean Specifies whether the form fields need to be exported.

Default value: false

cHRef String Specifies a device independent path that would be displayed in the resulting file. If empty - the document's path will be used.

Default value: Empty String

IncludeEmptyFields Boolean Specifies whether the empty fields should be exported.

Default value: false

ExcludePassword Boolean Specifies whether the text fields with password flag will be exported.

Default value: true

ExportFieldFlags Boolean Specifies whether the field flags should be exported.

Default value: false

FieldNames Array Array of String

Specifies the names of the fields that should be exported.

DestFile IUnknown Specifies the destination file into which the comments and fields will be exported. Can be IAFS_Name, IAFS_File or IStream.