CTInterfaceSetXMLData Method

When OnSaveToStoragePre is invoked (during document save-operation), this function can be used to manipulate CustomScope data in XML. Data that CUSTOMTOOLS was about to store can be accessed with GetXMLData using the same key.

Namespace: ATR.CT.CTInterface
Assembly: CTInterface (in CTInterface.dll) Version: 25.0

Syntax

Copy

public bool SetXMLData(
	string oKey,
	string oXmlData
)

Public Function SetXMLData ( 
	oKey As String,
	oXmlData As String
) As Boolean

Parameters

oKey String

CTEngineLib.ctPropertyScope.ctPropertyScopeCustom1, ...2, ...3 or ...4's integer value as string. Eg.

Copy

var oKey = "" + (int)CTEngineLib.ctPropertyScope.ctPropertyScopeCustom1; // == "128"

oXmlData String

Data to store. The XMl must be of valid format for CUSTOMTOOLS to handle. The XML format is not guaranteed to stay same in the future.

Return Value

Boolean
Always true

Revision History

Date	Version	Description
-	2015 SP2	First Release

Reference

CTInterface Class

ATR.CT.CTInterface Namespace