op.newBlankDoc

From Tracker Software PDF SDK
Jump to: navigation, search
(Created page with "Category:Editor {{#customTitle:Operation op.newBlankDoc}} {{#parentPage:PXV:Operations}} {{ToWrite}} {{ToReview}} == Overview == == == {| class="wikitable operation" ! '...")
 
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
{{#customTitle:Operation op.newBlankDoc}}
+
{{#customTitle:op.newBlankDoc}}
{{#parentPage:PXV:Operations}}
+
{{#parentPage:PXV:Operations|op.newBlankDoc|operation}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
 +
The operation allows to create new PDF document.
  
== ==
+
== Parameters ==
 
{| class="wikitable operation"
 
{| class="wikitable operation"
! '''Name'''
+
! style="width:60pt;" | '''Name'''
! '''Type'''
+
! style="width:60pt;" | '''Type'''
 
! '''Description'''
 
! '''Description'''
 
|-
 
|-
| Input || Array || Array of IUnknown-based objects
+
| class="op_param_name" | Input
 +
| style="text-align:center" | Array
 +
| No input should be specified.
 
|-
 
|-
| Output || Array || Array of IUnknown-based objects
+
| class="op_param_name" | Output
 +
| style="text-align:center;" | IUnknown
 +
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] that was created.
 
|-
 
|-
| [[PXV:op_newBlankDoc_Options|Options]] || Dict || Dictionary with options of the operation
+
| class="op_param_name" | [[PXV:op_newBlankDoc_Options|Options]]
 +
| style="text-align:center;" | Dictionary
 +
| Dictionary with options of the operation.
 
|}
 
|}
 +
 +
== Sample ==
 +
<pre class="brush:c#">//C#
 +
private void NewBlankDoc(PDFXEdit.IPXV_MainFrame mainFrm, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.newBlankDoc", false);
 +
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
 +
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
 +
options["PaperType"].v = 1;
 +
options["StdPaperIndex"].v = 10; //B5
 +
options["Count"].v = 11;
 +
Op.Do();
 +
PDFXEdit.IPXC_Document doc = (PDFXEdit.IPXC_Document)Op.Params.Root["Output"].v;
 +
//Opening document in the given main Frame
 +
mainFrm.OpenDocFrom(doc);
 +
}
 +
</pre>

Latest revision as of 22:57, 20 April 2016


Overview

The operation allows to create new PDF document.

Parameters

Name Type Description
Input Array No input should be specified.
Output IUnknown IUnknown-based object containing the IPXC_Document that was created.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void NewBlankDoc(PDFXEdit.IPXV_MainFrame mainFrm, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.newBlankDoc", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	PDFXEdit.ICabNode options = Op.Params.Root["Options"];
	options["PaperType"].v = 1;
	options["StdPaperIndex"].v = 10; //B5
	options["Count"].v = 11;
	Op.Do();
	PDFXEdit.IPXC_Document doc = (PDFXEdit.IPXC_Document)Op.Params.Root["Output"].v;
	//Opening document in the given main Frame
	mainFrm.OpenDocFrom(doc);
}