Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
(Label ToWrite removed)
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_fields_modify|Options|property}}
 
{{#parentPage:PXV:op_fields_modify|Options|property}}
−
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 14: Line 14:
 
| class="op_param_name" | Mask
 
| class="op_param_name" | Mask
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies...
+
| Specifies the [[PXV:PXV_OpModifyFieldMaskFlags|PXV_OpModifyFieldMaskFlags]] that defines the values that need to be modified.
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
−
|-
 
−
| class="op_param_name" | Flags
 
−
| style="text-align:center" | Integer
 
−
| Specifies...
 
−
Default value: <tt>'''0'''</tt>
 
−
|-
 
−
| class="op_param_name" | FlagsMask
 
−
| style="text-align:center" | Integer
 
−
| Specifies...
 
−
Default value: <tt>'''-1'''</tt>
 
−
|-
 
−
| class="op_param_name" | UserName
 
−
| style="text-align:center" | String
 
−
| Specifies...
 
−
Default value: <tt>'''Empty String'''</tt>
 
−
|-
 
−
| class="op_param_name" | ExportName
 
−
| style="text-align:center" | String
 
−
| Specifies...
 
−
Default value: <tt>'''Empty String'''</tt>
 
 
|-
 
|-
 
| class="op_param_name" | [[#Value|Value]]
 
| class="op_param_name" | [[#Value|Value]]
 
| style="text-align:center" | Dictionary
 
| style="text-align:center" | Dictionary
−
| Specifies...
+
| Specifies the value of the field option item. The ''OpModifyField_Value'' (0x00000100) mask flag should be specified.
 
|-
 
|-
 
| class="op_param_name" | [[#DefaultValue|DefaultValue]]
 
| class="op_param_name" | [[#DefaultValue|DefaultValue]]
 
| style="text-align:center" | Dictionary
 
| style="text-align:center" | Dictionary
−
| Specifies...
+
| Specifies the fields' default value. The ''OpModifyField_DefValue'' (0x00000200) mask flag should be specified.
 
|-
 
|-
 
| class="op_param_name" | RichValue
 
| class="op_param_name" | RichValue
 
| style="text-align:center" | String
 
| style="text-align:center" | String
−
| Specifies...
+
| Specifies the rich value of the form field. The ''OpModifyField_RichValue'' (0x00000080) mask flag should be specified.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | DateTimeValue
 
| class="op_param_name" | DateTimeValue
 
| style="text-align:center" | Integer64
 
| style="text-align:center" | Integer64
−
| Specifies...
+
| Specifies the fields' date and time value (FILETIME structure is used for this). The ''OpModifyField_DateTimeValue'' (0x00000400) mask flag should be specified.
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | MaxLen
 
| class="op_param_name" | MaxLen
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies...
+
| Specifies the fields' maximum length. The ''OpModifyField_MaxLen'' (0x00000008) mask flag should be specified.
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
 
|-
 
|-
Line 63: Line 43:
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
 
| Array of <tt>'''[[#OptList|Dictionary]]'''</tt>
 
| Array of <tt>'''[[#OptList|Dictionary]]'''</tt>
−
Specifies...
+
Specifies the fields' options list. The ''OpModifyField_OptList'' (0x00000040) mask flag should be specified.
 
|-
 
|-
 
| class="op_param_name" | TopIndex
 
| class="op_param_name" | TopIndex
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies...
+
| Specifies the top index for the ''FFT_ListBox'' fields type. The ''OpModifyField_TopIndex'' (0x00000010) mask flag should be specified.
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
−
|-
 
−
| class="op_param_name" | [[#Lock|Lock]]
 
−
| style="text-align:center" | Dictionary
 
−
| Specifies...
 
−
|-
 
−
| class="op_param_name" | Trigger
 
−
| style="text-align:center" | Integer
 
−
| Specifies...
 
−
The list of possible values are shown in [[PXV:Params_NamedValues_ActionTriggers|the table]].
 
−
 
−
Default value: <tt>'''14''' (Format)</tt>
 
−
|-
 
−
| class="op_param_name" | Actions
 
−
| style="text-align:center" | IUnknown
 
−
| Specifies...
 
 
|}
 
|}
  
Line 95: Line 60:
 
| class="op_param_name" | NoValue
 
| class="op_param_name" | NoValue
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
−
| Specifies...
+
| Specifies that the fields' values should be cleared.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Value
 
| class="op_param_name" | Value
 
| style="text-align:center" | String
 
| style="text-align:center" | String
−
| Specifies...
+
| Specifies the fields' value. The ''OpModifyField_SelectedIndices'' (0x00000800) flag should be omitted for this.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
Line 106: Line 71:
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
 
| Array of <tt>'''Integer'''</tt>
 
| Array of <tt>'''Integer'''</tt>
−
Specifies...
+
Specifies the fields' selection. The ''OpModifyField_SelectedIndices'' (0x00000800) flag should be specified.
 
|}
 
|}
  
Line 118: Line 83:
 
| class="op_param_name" | NoValue
 
| class="op_param_name" | NoValue
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
−
| Specifies...
+
| Specifies that the fields' default values should be empty.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Value
 
| class="op_param_name" | Value
 
| style="text-align:center" | String
 
| style="text-align:center" | String
−
| Specifies...
+
| Specifies the fields' default value. The ''OpModifyField_SelectedIndices'' (0x00000800) flag should be omitted for this.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
Line 129: Line 94:
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
 
| Array of <tt>'''Integer'''</tt>
 
| Array of <tt>'''Integer'''</tt>
−
Specifies...
+
Specifies the default fields' selection. The ''OpModifyField_SelectedIndices'' (0x00000800) flag should be specified.
 
|}
 
|}
  
Line 141: Line 106:
 
| class="op_param_name" | Value
 
| class="op_param_name" | Value
 
| style="text-align:center" | String
 
| style="text-align:center" | String
−
| Specifies...
+
| Specifies the option's real key value.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | DispValue
 
| class="op_param_name" | DispValue
 
| style="text-align:center" | String
 
| style="text-align:center" | String
−
| Specifies...
+
| Specifies the option's value that will be displayed.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
−
|}
 
−
 
−
== Lock Table ==
 
−
 
−
{| class="wikitable op_options" id="Lock"
 
−
! style="width:120pt;" | '''Name'''
 
−
! style="width:60pt;" | '''Type'''
 
−
! '''Value'''
 
−
|-
 
−
| class="op_param_name" | Action
 
−
| style="text-align:center" | Integer
 
−
| Specifies...
 
−
Default value: <tt>'''0'''</tt>
 
−
|-
 
−
| class="op_param_name" | Fields
 
−
| style="text-align:center" | Array
 
−
| Array of <tt>'''String'''</tt>
 
−
Specifies...
 
−
|-
 
−
| class="op_param_name" | Permissions
 
−
| style="text-align:center" | Integer
 
−
| Specifies...
 
−
Default value: <tt>'''0'''</tt>
 
 
|}
 
|}

Latest revision as of 01:34, 15 August 2017

PDF Editor Layer > Operations > op.fields.modify > Options


Options Table

Name Type Value
Mask Integer Specifies the PXV_OpModifyFieldMaskFlags that defines the values that need to be modified.

Default value: 0

Value Dictionary Specifies the value of the field option item. The OpModifyField_Value (0x00000100) mask flag should be specified.
DefaultValue Dictionary Specifies the fields' default value. The OpModifyField_DefValue (0x00000200) mask flag should be specified.
RichValue String Specifies the rich value of the form field. The OpModifyField_RichValue (0x00000080) mask flag should be specified.

Default value: Empty String

DateTimeValue Integer64 Specifies the fields' date and time value (FILETIME structure is used for this). The OpModifyField_DateTimeValue (0x00000400) mask flag should be specified.

Default value: 0

MaxLen Integer Specifies the fields' maximum length. The OpModifyField_MaxLen (0x00000008) mask flag should be specified.

Default value: 0

OptList Array Array of Dictionary

Specifies the fields' options list. The OpModifyField_OptList (0x00000040) mask flag should be specified.

TopIndex Integer Specifies the top index for the FFT_ListBox fields type. The OpModifyField_TopIndex (0x00000010) mask flag should be specified.

Default value: 0

Value Table

Name Type Value
NoValue Boolean Specifies that the fields' values should be cleared.

Default value: false

Value String Specifies the fields' value. The OpModifyField_SelectedIndices (0x00000800) flag should be omitted for this.

Default value: Empty String

Selection Array Array of Integer

Specifies the fields' selection. The OpModifyField_SelectedIndices (0x00000800) flag should be specified.

DefaultValue Table

Name Type Value
NoValue Boolean Specifies that the fields' default values should be empty.

Default value: false

Value String Specifies the fields' default value. The OpModifyField_SelectedIndices (0x00000800) flag should be omitted for this.

Default value: Empty String

Selection Array Array of Integer

Specifies the default fields' selection. The OpModifyField_SelectedIndices (0x00000800) flag should be specified.

OptList Table

Name Type Value
Value String Specifies the option's real key value.

Default value: Empty String

DispValue String Specifies the option's value that will be displayed.

Default value: Empty String

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:op_fields_modify_Options&oldid=50887"