op.document.removeBackground

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:op.document.removeBackground}}
 
{{#customTitle:op.document.removeBackground}}
 
{{#parentPage:PXV:Operations|op.document.removeBackground|operation}}
 
{{#parentPage:PXV:Operations|op.document.removeBackground|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview...
+
The operation allows to remove any existing background from the 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
| Array of <code>IUnknown</code>-based objects.
+
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] which the background will be removed from.
 
|-
 
|-
 
| class="op_param_name" | Output
 
| class="op_param_name" | Output
| style="text-align:center;" | Array
+
| style="text-align:center;" | IUnknown
| Array of <code>IUnknown</code>-based objects.
+
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] with removed background. Not yet implemented.
 
|}
 
|}
 +
 +
== Sample ==
 +
<pre class="brush:c#">//C#
 +
private void RemoveBackground(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.document.removeBackground", false);
 +
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
 +
var input = Op.Params.Root["Input"];
 +
input.v = Doc.CoreDoc;
 +
Op.Do();
 +
}
 +
</pre>

Latest revision as of 07:42, 20 April 2016


Overview

The operation allows to remove any existing background from the document.

Parameters

Name Type Description
Input IUnknown IUnknown-based object containing the IPXC_Document which the background will be removed from.
Output IUnknown IUnknown-based object containing the IPXC_Document with removed background. Not yet implemented.

Sample

//C#
private void RemoveBackground(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.document.removeBackground", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	var input = Op.Params.Root["Input"];
	input.v = Doc.CoreDoc;
	Op.Do();
}