CTInterface.GetXMLData Method

CTInterfaceGetXMLData Method

When OnSaveToStoragePre is invoked (during document save-operation), this function can be used to retrieve current CustomScope data in XML. Modified data can be sent back for CUSTOMTOOLS with SetXMLData using the same key.

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

Syntax

Copy

public string GetXMLData(
	string oKey
)

Public Function GetXMLData ( 
	oKey As String
) As String

Parameters

oKey

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

Copy

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

Return Value

Type: String
Data that CUSTOMTOOLS is about to store for the document provided with previous OnSaveToStoragePre -event. The XML format is not guaranteed to stay same in the future.

Availability

CUSTOMTOOLS 2015 SP2

Reference

CTInterface Class

ATR.CT.CTInterface Namespace