	Developers
	Developers Home
	EditLive! for Java
	EditLive! for Windows
		System Requirements
		Getting Started
		Integration Samples
		Articles
		API Reference
	EditLive! for XML
	Discussion Forums

EditLive Object

An EditLive object is a JavaScript object which offers a content creation interface for non-technical users. It contains properties, methods and events that allow you to write information to and retrieve information from the object as well as customize the features available within the object.

The following code shows how to create a new EditLive JavaScript object.

...

<script language="JavaScript1.2">

<!--

...



var editLive1 = new EditLive("Plugin1", 600, 350);



//-->

</script>

...

Syntax

var JSObjectName = new EditLive( actualControlName, width, height )

Parameters

JSObjectName String that represents the name of the EditLive object.

actualControlName String that serves no purpose in the current version of EditLive. Note: the value cannot be the same as JSObjectName.

width Number that specifies the width of the object in pixels or as a percentage.

height Number that specifies the height of the object in pixels or as a percentage.

Methods

EditLive Methods Index

Properties

EditLive Properties Index

Events

EditLive Events Index

EditLive Methods	Available EditLive! methods in alphabetical order
ActivateLicense	Communicates with a license server to activate a seat license.
AddToolbarButton	Adds a custom toolbar button to the end of the specified toolbar.
AllowItem	Indicates whether or not an item on the toolbars and menu bar can be used.
ClearFontColors	Clears the list of font colors available to end users.
ClearFontList	Clears the list of fonts available to end users.
ClearFontSizeList	Clears the list of font sizes available to end users.
InsertHTMLAtCursor	Inserts a piece of HTML code directly into the document at the current cursor position.
InsertHyperlinkAtCursor	Turns the currently selected text or image in the document into a link to a given URL.
InsertImageAtCursor	Inserts an image directly into the document at the current cursor position.
LoadFile	Opens a file from the FTP server for editing.
LoadFont	Loads a font name into the EditLive! font list.
LoadFontColor	Loads a specific font color into EditLive!.
LoadFontSize	Loads a specific font size into EditLive!.
LoadStyleSheet	Loads the rules corresponding to the named style sheet and adds them to the collection.
LoadStyleSheetWithMedia	Loads the rules corresponding to the named style sheet and adds them to the collection, specifying the media type that the style sheet is relevant for.
LoadURL	Loads content from a HTTP server.
NewFile	Creates a blank document within EditLive!.
RemoveItem	Removes all instances of an item from the toolbars and menu bar.
RemoveToolbarItem (Deprecated)	Removes existing buttons from the specified toolbar.
ServerRegister	Deploys a registration key to users working on a particular domain.
SaveFile	Saves the file currently within EditLive!.
UploadImages	Triggers EditLive! to upload any local images to the FTP server.

EditLive Properties Available EditLive! properties in alphabetical order

AllowAnchor
(Deprecated) Indicates user permissions with respect to whether they may insert anchors or not.

AllowBold
(Deprecated) Indicates user permissions with respect to whether they may make text bold or not.

AllowFirewall Indicates user permissions with respect to whether users can change their FTP firewall or proxy settings to allow FTP through a firewall or proxy server.

AllowFont
(Deprecated) Indicates user permissions with respect to whether they may change the font face or not.

AllowFontColor
(Deprecated) Indicates user permissions with respect to whether they may change the font color or not.

AllowFontSize
(Deprecated) Indicates user permissions with respect to whether they may change font size or not.

AllowFormat
(Deprecated) Indicates user permissions with respect to whether they may access the styles drop down box.

AllowHelp
(Deprecated) Indicates whether the EditLive! Help manual is available or not.

AllowHorizontalRule
(Deprecated) Indicates user permissions with respect to whether they may insert horizontal rules or not.

AllowHyperlinks
(Deprecated) Indicates user permissions with respect to whether they may insert hyperlinks or not.

AllowIndent
(Deprecated) Indicates user permissions with respect to whether they may indent bodies of text.

AllowItalic
(Deprecated) Indicates user permissions with respect to whether they may make text italic or not.

AllowJustifyCenter
(Deprecated) Indicates user permissions with respect to whether they may center justify text.

AllowJustifyLeft
(Deprecated) Indicates user permissions with respect to whether they may left justify text.

AllowJustifyRight
(Deprecated) Indicates user permissions with respect to whether they may right justify text.

AllowListOrdered
(Deprecated) Indicates user permissions with respect to whether they may create ordered lists (i.e. numbered lists).

AllowListUnordered
(Deprecated) Indicates user permissions with respect to whether they may create unordered lists (i.e. bullet points).

AllowOutdent
(Deprecated) Indicates user permissions with respect to whether they may move in previously indented bodies of text.

AllowPageProperties
(Deprecated) Indicates user permissions with respect to whether they may change page properties (e.g. title, meta tags) or not.

AllowParagraphChars
(Deprecated) Indicates user permissions with respect to whether they may display paragraph marks or not.

AllowReadOnlyAreas Indicates user permissions with respect to whether they may edit content inside readonly areas or not.

AllowSpecialChars
(Deprecated) Indicates user permissions with respect to whether they may insert special characters or not.

AllowSubscript
(Deprecated) Indicates user permissions with respect to whether they may make text subscript or not.

AllowSuperscript
(Deprecated) Indicates user permissions with respect to whether they may make text superscript or not.

AllowStyleSheetFormattingOnly Indicates whether the styles drop down box is limited to styles defined in a specified style sheet..

AllowTableColAdd
(Deprecated) Indicates user permissions with respect to whether they may insert columns into tables or not.

AllowTableColDel
(Deprecated) Indicates user permissions with respect to whether they may delete columns from tables or not.

AllowTableInsert
(Deprecated) Indicates user permissions with respect to whether they may insert tables or not.

AllowTableRowAdd
(Deprecated) Indicates user permissions with respect to whether they may insert rows into tables or not.

AllowTableRowDel
(Deprecated) Indicates user permissions with respect to whether they may delete rows from tables or not.

AllowTables Indicates user permissions with respect to whether they may access table functionality or not.

AllowUnderline
(Deprecated) Indicates user permissions with respect to whether they may underline text in the document or not.

BodyAttribute Sets the value of a specified page attribute and value into the BODY tag within EditLive!.

DisableCustomization Indicates user permissions with respect to whether they may apply their own customizations to the EditLive! interface or not.

EditLiveMode Indicates which mode EditLive! is running in (HTMLString, FTPStandard, FTPFileManager, FTPFileManagerReadOnly, ViewOnly).

EditorMode Indicates the whether users have access to just the WYSIWYG view or both the WYSIWYG view and the HTML view.

Filter Indicates user permissions with respect to whether they may use the filter function to clean the HTML source code or not.

FilterFontStyles Indicates whether the presentation tags (e.g. font, bold, italic, underline) in the HTML source code are converted to style rules when the EditLive! content is retrieved.

FilterFormatAttributes Indicates whether the case of attribute names (e.g. color, border, name) will be altered in the HTML source code when the EditLive! content is retrieved.

FilterFormatIndent Indicates whether the relevant tags in the HTML source code should be indented to make the code more readable when the EditLive! content is retrieved.

FilterFormatTags Indicates whether the case of tag names, such as BODY and FONT, will be altered in the HTML source code when the EditLive! content is retrieved.

FilterFormatWrap Indicates a line length that is used to wrap the HTML source code when the EditLive! content is retrieved.

FilterNumericEntities Indicates whether any special characters inserted into EditLive! are translated to numeric entities in the HTML source code when the EditLive! content is retrieved.

FilterOptionalTags Indicates whether extraneous tags should be removed from the HTML source code when the EditLive! content is retrieved.

FilterOutputXHTML Indicates whether the HTML source code is output as XHTML when the EditLive! content is retrieved.

FilterOutputXML Indicates whether the HTML source code is output as XML when the EditLive! content is retrieved.

FilterSpecialChars Indicates whether any special characters inserted into EditLive! are translated to correct HTML notation in the HTML source code when the EditLive! content is retrieved.

FTPInitialDirectory Indicates the directory utilized on the FTP server.

FTPPassword Indicates the password used to connect to the FTP server.

FTPServer Indicates the FTP server used for file operations and inserting images.

FTPServerPort Indicates the FTP server port used for file operations and for inserting images.

FTPUsername Indicates the username used to login to the FTP server.

HTTPCookie Declares that cookie information should be sent with the HTTP request when uploading images to the server using the HTTP method.

HTTPImageRoot Sets and returns the URL used to calculate the absolute web address of local images uploaded to the web server via the HTTP POST method.

HTTPImageURL Defines the URL of a page containing images or links to images available on the remote server when the HTTP protocol is being used.

ImageMode Indicates the locations from which images can be inserted into EditLive!.

ImageURLType Indicates whether, if possible, image references should be absolute or relative.

IsDirty Indicates whether the document within EditLive! has been modified since a file was loaded or the Source property was set.

POSTAcceptorURL Indicates the location of the script used for uploading images inserted from a local machine via the HTTPPOST method to a remote server. By setting this property, the protocol used is HTTP.

RemoveTags Removes any instances of the specified tag within EditLive!.

SavedFileName When a new file within EditLive! has been saved, this property returns the name that the file was saved as, including the extension.

SavedFilePath When a new file within EditLive! has been saved, this property returns the name of the directory where the EditLive! file was saved.

SelectedText Retrieves any content highlighted within EditLive!. The retrieved content does not include any of the HTML code within the content.

SelectedHTML Retrieves any content highlighted within EditLive!. The retrieved content includes all of the HTML code within the content, meaning formatting information is preserved.

Source Sets or retrieves the raw HTML code between the BODY tags of the document within EditLive!.

SourceAll Sets or retrieves all of the raw HTML code of the document within EditLive!.

StyleElementText Sets or retrieves the first STYLE element within the HEAD section of the document within EditLive!.

StylesOnlyMode Indicates whether StylesOnlyMode is enabled or disabled. If it is enabled then the lower tool bar for text formatting is not available to users except for the predefined styles box.

Text Returns the viewable text contents of the current document in EditLive!.

ValidHtml Indicates if the content inside EditLive! for Windows is valid HTML.

VersionBuild Returns the revision number of the EditLive! plug-in the user has installed.

VersionMajor Returns the major build number of the EditLive! plug-in the user has installed.

VersionMinor Returns the minor build number of the EditLive! plug-in the user has installed.

WebDAVPassword Indicates the password used to connect to the WebDAV server.

WebDAVURL Indicates the WebDAV server used for file operations and inserting images.

WebDAVUsername Indicates the username used to login to the WebDAV server.

WebRoot Sets and returns the URL used for relative links and image references.

WordImportOption When EditLive! content is pasted into EditLive! from MS Word, this property sets whether the cascading style sheet (CSS) rules which dictate the formatting of the content are included with the other styles defined within EditLive! or disregarded to allow a standard formatting to be applied to the contents.

EditLive Events Available EditLive! events in alphabetical order

onafterpaste Raises an event after a user pastes content into EditLive!.

ontoolbarbuttonclick Raises an event whenever a user clicks a button on the EditLive! toolbars.

Copyright © 1999-2005 Ephox Corporation. All Rights Reserved. 'Ephox' is a registered trademark of Ephox Corporation.
Java and the Java Powered logo are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.