EditLive! 9 Documentation : setConfigurationFile Method

Created by Jessica Hardy, last modified by Mark Terry on Mar 20, 2014

This property specifies the URL at which the configuration file for EditLive! can be found. This file will customize the EditLive! interface. You may like to look at the setConfigurationText Method if you are considering dynamically generating EditLive! configuration files, but otherwise it is probably simpler to use this ConfigurationFile property. 

Syntax

Visual Basic Script
object.ConfigurationFile = strFileURL
ASP .NET
prefix:EditLiveJava ConfigurationFile = strFileURL
JavaScript
editliveInstance.setConfigurationFile(strFileURL);

Parameters

strFileURL

A string which is the URL for where the configuration file for this instance of EditLive! can be requested from. Ensure this string is correctly URL encoded.

Examples

The following code specifies that EditLive! is to be loaded with the properties specified by the file config.xml, which can be found at http://someserver/xmlconfig/config.xml.

VBScript
editlive1.ConfigurationFile = "http://someserver/xmlconfig/config.xml"
ASP.NET Server Control
<elj:EditLiveJava 
  ...
  ConfigurationFile = "http://someserver/xmlconfig/config.xml" 
  ... 
/>
JavaScript
editlivejs.setConfigurationFile("http://someserver/xmlconfig/config.xml");

Remarks

Using the setConfigurationText Method to configure EditLive! results in a faster load time for the EditLive! applet than is achieved through the use of the ConfigurationFile property. If ConfigurationFile and ConfigurationText are both specified for an instance of the editor, ConfigurationText will take precedence.

If neither ConfigurationFile or ConfigurationText are specified, EditLive! will attempt to load the sample_eljconfig.xml configuration file located in the directory specified by the setDownloadDirectory Method.

Example

The following two code snippets would both specify the URL for the EditLive! configuration file as ../../redistributables/editlivejava/sample_eljconfig.xml.

<html>
       <body>
               <script language="Javascript" src="../../redistributables/editlivejava/editlivejava.js"></script>
               <script language="Javascript">
                       var editliveRef = new EditLiveJava("editlive", 700, 400);
                       editliveRef.setDownloadDirectory("../../redistributables/editlivejava");
                       editliveRef.setConfigurationFile("../../redistributables/editlivejava/sample_eljconfig.xml");
                       editliveRef.show();
               </script>
       </body>
</html>
<html>
       <body>
               <script language="Javascript" src="../../redistributables/editlivejava/editlivejava.js"></script>
               <script language="Javascript">
                       var editliveRef = new EditLiveJava("editlive", 700, 400);
                       editliveRef.setDownloadDirectory("../../redistributables/editlivejava");
                       editliveRef.show();
               </script>
       </body>
</html>

See Also