SerializableObject object

 

 

Prototype for SerializableObject objects.

Syntax

you cannot create a SerializableObject, only derived typed can be created such as: URL object or ConfigurationObject derived objects. 

Parameters

 none.

Property Of

none.

Implemented In

ECMerge 2.1

Description

 SerializableObject objects can be serialized to XML and set from a XML string.

Properties

no specific properties. 

Methods

toString
as_xml
set_xml

Examples

Example 1.

Take the parameters for my_document and logs their XML representation.

var param = my_document.parameters;
log (param.as_xml());

See Also 

 ConfigurationObject object

Method toString / as_xml

Syntax

function toString ( )
function as_xml ( )
returns a String

Parameters

none.

Method Of

SerializableObject object.

Implemented In

ECMerge 2.1

Description

Returns a XML textual representation of the serializable object.

See Also 

 SerializableObject object, SerializableObject.set_xml method.

Method set_xml

Syntax

function set_xml (xml_string)

Parameters

xml_string. String. XML representation, as saved by as_xml.

Method Of

SerializableObject object.

Implemented In

ECMerge 2.1

Description

Sets the value in the object from a XML textual representation serialized earlier with as_xml( ).

Examples

Example 1.

Saves an OptionsSet as an XML string then create another OptionsSet with same options:

var set1_xml = current_frame.coordinator.document.parameters.settings.as_xml();
var set2 = new OptionsSet();
set2.set_xml (set1_xml);

See Also 

 SerializableObject object, SerializableObject.as_xml method