EditLive! 9 Documentation : setConfigurationText Method

This property or the setConfigurationFile Method (but not both) is required to be set for an Tiny EditLive! applet to run. 

This property specifies the XML configuration text to be used by EditLive!. This text will customise the EditLive! interface. To find out about how to use EditLive! Configuration files, please read the article on Manually Editing Configuration Files and the EditLive! Configuration File Elements reference. The ConfigurationText property allows for the configuration of EditLive! via a string containing the configuration XML document to be used with EditLive!. Loading the configuration via the ConfigurationText property can reduce the load time of EditLive!. 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!.


Visual Basic Script
object.ConfigurationText = strXMLText
prefix:EditLiveJava ConfigurationText = strXMLText



A string which contains the text of the XML configuration document for this instance of EditLive!.


The following code would specify that Tiny EditLive! is to load with the given XML Configuration Text.

editlive1.ConfigurationText = "<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE editLive SYSTEM '..'><editLive> <document>..."
ASP.NET Server Control
  ConfigurationText= "<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE editLive SYSTEM '..'><editLive> <document>..." 

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 URL encoding functions do not fully comply with the URL encoding standard.

The XML document in the examples above is incomplete. It is given only as an example to aid understanding. The XML document passed to EditLive! via this method must be a complete XML configuration document.


Using the ConfigurationText property to configure EditLive! results in a faster load time than is achieved through the use of the setConfigurationFile Method.

The ConfigurationText property is mutually exclusive with the setConfigurationFile Method. You should provide either a URL to a configuration file, or pass in the configuration text in a String format.

See Also