op.imagesToDoc IOpInputItem additional parameters
From PDF XChange PDF SDK
(5 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Additional parameters for the wrapped input item of the imagesToDoc operation are generally used when there is a need to display to the end user alternative file attributes instead of the real ones. For example, when the item is a temporary file retrieved from the scanner operation, with the non-informative file path and name, fake attributes allow to display it in the dialog as the "Scanned Image #2" from "Cannon 4500". | |
== Parameters Table == | == Parameters Table == | ||
Line 15: | Line 15: | ||
| class="op_param_name" | DispTitle | | class="op_param_name" | DispTitle | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | | + | | If not empty, specifies the string which will be shown to the end user as the file title of the wrapped input item. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DispExt | | class="op_param_name" | DispExt | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | | + | | If not empty, specifies the string which will be shown to the end user as the file extension of the wrapped input item. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DispFolder | | class="op_param_name" | DispFolder | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | | + | | If not empty, specifies the string which will be shown to the end user as the location (file path) of the wrapped input item. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|} | |} | ||
+ | |||
+ | == See Also == | ||
+ | :[[PXV:op_imagesToDoc|op_imagesToDoc]] | ||
+ | :[[PXV:IOpInputItem|IOpInputItem]] |
Latest revision as of 00:59, 20 June 2015
Additional parameters for the wrapped input item of the imagesToDoc operation are generally used when there is a need to display to the end user alternative file attributes instead of the real ones. For example, when the item is a temporary file retrieved from the scanner operation, with the non-informative file path and name, fake attributes allow to display it in the dialog as the "Scanned Image #2" from "Cannon 4500".
Parameters Table
Name | Type | Value |
---|---|---|
DispTitle | String | If not empty, specifies the string which will be shown to the end user as the file title of the wrapped input item.
Default value: Empty String |
DispExt | String | If not empty, specifies the string which will be shown to the end user as the file extension of the wrapped input item.
Default value: Empty String |
DispFolder | String | If not empty, specifies the string which will be shown to the end user as the location (file path) of the wrapped input item.
Default value: Empty String |