op.document.insertPages

From PDF XChange PDF SDK
Jump to: navigation, search
(Sample)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
{{#customTitle:op.document.insertPages}}
 
{{#customTitle:op.document.insertPages}}
 
{{#parentPage:PXV:Operations|op.document.insertPages|operation}}
 
{{#parentPage:PXV:Operations|op.document.insertPages|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview allows you to insert pages from another PDF into the current document.
+
The operation overview allows you to insert pages into the current document from another PDF document.
  
 
== Parameters ==
 
== Parameters ==
Line 15: Line 14:
 
|-
 
|-
 
| class="op_param_name" | Input
 
| class="op_param_name" | Input
| style="text-align:center" | Array
+
| style="text-align:center" | IUnknown
 
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] that will have it's pages changed.
 
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] that will have it's pages changed.
 
|-
 
|-
 
| class="op_param_name" | Output
 
| class="op_param_name" | Output
| style="text-align:center;" | Array
+
| style="text-align:center;" | IUnknown
 
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] that had it's pages changed.
 
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] that had it's pages changed.
 
|-
 
|-
Line 32: Line 31:
 
{
 
{
 
int nID = Inst.Str2ID("op.document.insertPages", false);
 
int nID = Inst.Str2ID("op.document.insertPages", false);
PDFXEdit.IOperation pOp = Inst.CreateOp(nID);
+
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
PDFXEdit.ICabNode input = pOp.Params.Root["Input"];
+
PDFXEdit.ICabNode input = Op.Params.Root["Input"];
 
input.v = Doc;
 
input.v = Doc;
PDFXEdit.ICabNode options = pOp.Params.Root["Options"];
+
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
 
//Creating IAFS_Name path from string path
 
//Creating IAFS_Name path from string path
 
PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
 
PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
Line 47: Line 46:
 
options["PagesRange.Type"].v = "Exact";
 
options["PagesRange.Type"].v = "Exact";
 
options["PagesRange.Text"].v = "1-3"; //Select pages range that will be deleted from the document
 
options["PagesRange.Text"].v = "1-3"; //Select pages range that will be deleted from the document
pOp.Do();
+
Op.Do();
 
}
 
}
 
</pre>
 
</pre>

Latest revision as of 01:05, 19 April 2016


Overview

The operation overview allows you to insert pages into the current document from another PDF document.

Parameters

Name Type Description
Input IUnknown IUnknown-based object containing the IPXC_Document that will have it's pages changed.
Output IUnknown IUnknown-based object containing the IPXC_Document that had it's pages changed.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void InsertPages(PDFXEdit.IPXV_Document Doc, PDFXEdit.PXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.document.insertPages", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	PDFXEdit.ICabNode input = Op.Params.Root["Input"];
	input.v = Doc;
	PDFXEdit.ICabNode options = Op.Params.Root["Options"];
	//Creating IAFS_Name path from string path
	PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
	PDFXEdit.IAFS_Name destPath = fsInst.DefaultFileSys.StringToName("D:\\TestFile.pdf");
	options["Position"].v = 0; //First page
	options["Location"].v = "Before"; //The pages will be inserted before first page
	options["CommentsAction"].v = "Copy"; //Copy all comments
	options["FieldsAction"].v = "Copy"; //Copy all fields
	options["BookmarksAction"].v = "CopyRelated"; //Copy bookmarks that are related to the inserted pages
	options["Src"].v = destPath; //Source document
	options["PagesRange.Type"].v = "Exact";
	options["PagesRange.Text"].v = "1-3"; //Select pages range that will be deleted from the document
	Op.Do();
}