op.document.changeInfo
From PDF XChange PDF SDK
(Automatic page editing by robot) |
(→Sample) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:op.document.changeInfo}} | {{#customTitle:op.document.changeInfo}} | ||
{{#parentPage:PXV:Operations|op.document.changeInfo|operation}} | {{#parentPage:PXV:Operations|op.document.changeInfo|operation}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
| − | The operation | + | The operation allows to change specified document's properties. |
== 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 | ||
| − | | | + | | <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] that will have it's properties changed. |
|- | |- | ||
| 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 [[PXV:IPXC_Document|IPXC_Document]] that had it's properties changed. |
|- | |- | ||
| class="op_param_name" | [[PXV:op_document_changeInfo_Options|Options]] | | class="op_param_name" | [[PXV:op_document_changeInfo_Options|Options]] | ||
| Line 26: | Line 25: | ||
| Dictionary with options of the operation. | | Dictionary with options of the operation. | ||
|} | |} | ||
| + | |||
| + | == Sample == | ||
| + | <pre class="brush:c#">//C# | ||
| + | private void ChangeDocumentInfo(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) | ||
| + | { | ||
| + | int nID = Inst.Str2ID("op.document.changeInfo", false); | ||
| + | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
| + | var input = Op.Params.Root["Input"]; | ||
| + | input.Add().v = Doc.CoreDoc; | ||
| + | PDFXEdit.ICabNode options = Op.Params.Root["Options"]; | ||
| + | options["Flags"].v = (int)PDFXEdit.PXV_ChangeDocPropsFlag.CDPF_Title | (int)PDFXEdit.PXV_ChangeDocPropsFlag.CDPF_ViewFlags; | ||
| + | options["ViewFlags"].v = (1 << (int)PDFXEdit.PXC_DocumentViewFlags.DocViewFlag_DisplayDocTitle); | ||
| + | options["Title"].v = "Your custom title"; | ||
| + | Op.Do(); | ||
| + | } | ||
| + | </pre> | ||
Latest revision as of 05:50, 28 October 2016
Overview
The operation allows to change specified document's properties.
Parameters
| Name | Type | Description |
|---|---|---|
| Input | Array | IUnknown-based object containing the IPXC_Document that will have it's properties changed.
|
| Output | Array | IUnknown-based object containing the IPXC_Document that had it's properties changed.
|
| Options | Dictionary | Dictionary with options of the operation. |
Sample
//C#
private void ChangeDocumentInfo(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
int nID = Inst.Str2ID("op.document.changeInfo", false);
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
var input = Op.Params.Root["Input"];
input.Add().v = Doc.CoreDoc;
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
options["Flags"].v = (int)PDFXEdit.PXV_ChangeDocPropsFlag.CDPF_Title | (int)PDFXEdit.PXV_ChangeDocPropsFlag.CDPF_ViewFlags;
options["ViewFlags"].v = (1 << (int)PDFXEdit.PXC_DocumentViewFlags.DocViewFlag_DisplayDocTitle);
options["Title"].v = "Your custom title";
Op.Do();
}
