op.textToDoc

From PDF XChange PDF SDK
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:op.textToDoc}}
 
{{#customTitle:op.textToDoc}}
 
{{#parentPage:PXV:Operations|op.textToDoc|operation}}
 
{{#parentPage:PXV:Operations|op.textToDoc|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview...
+
The operation allows converting text files into [[PXV:IPXC_Document|IPXC_Document]].
  
 
== Parameters ==
 
== Parameters ==
Line 16: Line 15:
 
| class="op_param_name" | Input
 
| class="op_param_name" | Input
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
| Array of <code>IUnknown</code>-based objects containing the text, that need to be inserted to the document. [[PXV:IAFS_Name|IAFS_Name]], [[PXV:IAFS_File|IAFS_File]] objects.
+
| Array of <code>IUnknown</code>-based objects containing the text, that will be converted into [[PXV:IPXC_Document|IPXC_Document]]. The <code>IUnknown</code> type should be cast to the [[PXV:IAFS_Name|IAFS_Name]] or [[PXV:IAFS_File|IAFS_File]] interfaces, based on the input type that was used. Also the [[PXV:IOpInputItem|IOpInputItem]] interface with [[PXV:op_textToDoc_IOpInputItem_parameters|additional parameters]] can be passed.
 
|-
 
|-
 
| class="op_param_name" | Output
 
| class="op_param_name" | Output
 
| style="text-align:center;" | Array
 
| style="text-align:center;" | Array
| <code>IUnknown</code>-based object containing the created [[PXV:IPXC_Document|IPXC_Document]].
+
| <code>IUnknown</code>-based object containing the converted [[PXV:IPXC_Document|IPXC_Document]].
 
|-
 
|-
 
| class="op_param_name" | [[PXV:op_textToDoc_Options|Options]]
 
| class="op_param_name" | [[PXV:op_textToDoc_Options|Options]]
Line 26: Line 25:
 
| Dictionary with options of the operation.
 
| Dictionary with options of the operation.
 
|}
 
|}
 +
 +
== See Also ==
 +
:[[PXV:IOpInputItem|IOpInputItem]]
 +
:[[PXV:op_textToDoc_IOpInputItem_parameters|textToDoc operation's additional parameters for IOpInputItem]]

Latest revision as of 03:22, 11 May 2017


Overview

The operation allows converting text files into IPXC_Document.

Parameters

Name Type Description
Input Array Array of IUnknown-based objects containing the text, that will be converted into IPXC_Document. The IUnknown type should be cast to the IAFS_Name or IAFS_File interfaces, based on the input type that was used. Also the IOpInputItem interface with additional parameters can be passed.
Output Array IUnknown-based object containing the converted IPXC_Document.
Options Dictionary Dictionary with options of the operation.

See Also

IOpInputItem
textToDoc operation's additional parameters for IOpInputItem