This property or the ConfigurationFile property (but not both) is required to be set for an Ephox EditLive! for XML applet to run.
This property specifies the XML configuration text to be used by Ephox EditLive! for XML. This text will customise the Ephox EditLive! for XML interface. To find out about how to use XML Configuration files, please read EditLive! for XML Configuration reference. The ConfigurationText property allows the configuration of EditLive! for XML to be via a string which contains the configuration XML document to be used with EditLive! for XML. Loading the configuration for EditLive! for XML via the ConfigurationText property can reduce the load time of EditLive! for XML. This can be most easily achieved by using server-side scripting to load the configuration file from the server's file system into a scripting string variable which can then be used when instantiating EditLive! for XML.
A string which contains the text of the XML configuration document for this instance of Ephox EditLive! for XML.
Example 16.11. ConfigurationText Property Example Scripting
The following code would specify that Ephox EditLive! for XML is to load with the given XML Configuration Text.
JavaScript
editlivejs.setConfigurationText('%3C%3Fxml%20version%3D%221.0%22%3F%3E...');The string passed to the JavaScript setConfigurationText property must be URL encoded. It is recommended that a server-side URL encoding function be used if available as the JavaScript escape function does not fully comply with the URL encoding standard.
The XML document in the examples above URL encoded and incomplete. It is given only as an example to aid understanding. The XML document passed to EditLive! for XML via this method should by URL encoded.
Using the ConfigurationText property to configure EditLive! for XML results in a faster load time for the EditLive! for XML applet than is achieved through the use of the ConfigurationFile property.
The ConfigurationText property is mutually exclusive with the ConfigurationFile property. You should provide either a URL to a configuration file, or pass in the configuration text in a String format.
When using the JavaScript setConfigurationText property the string parameter must be URL encoded. It is recommended that a server-side URL encoding function be used if available as the JavaScript escape function does not fully comply with the URL encoding standard.
Copyright 2001-2004 Ephox Corporation. All Rights Reserved.