15.08.2013 Views

Ektron® eWebEditPro Developer's Reference Guide

Ektron® eWebEditPro Developer's Reference Guide

Ektron® eWebEditPro Developer's Reference Guide

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Name API Type Return<br />

Type<br />

Description<br />

actionOnUnload property Determines how content is saved when Web page is<br />

unloaded.<br />

addEventHandler method Defines event handlers for <strong>eWebEditPro</strong> events,<br />

such as onready.<br />

autoInstallExpected method Indicates if an automatic download and installation of<br />

<strong>eWebEditPro</strong> is expected.<br />

create method Creates an instance of an in-line editor in the page. 53<br />

createButton method Creates an instance of a button which, if clicked,<br />

opens a popup window with the editor in it.<br />

defineField method Loads more than one content field into the editor. 607<br />

edit method Opens a popup window with the editor in it. 55<br />

EstimateContentSize method long Estimates the size of current content. 60<br />

installPopup property boolean If true, a window with the intro.htm page pops up. 140<br />

instances collection property An array of in-line editor objects of type<br />

<strong>eWebEditPro</strong>Editor or <strong>eWebEditPro</strong>Alt.<br />

isAutoInstallSupported property boolean If true, <strong>eWebEditPro</strong> can be automatically installed. 140<br />

isChanged method boolean Determines if editor content has changed. 75<br />

isEditor method boolean Indicates if an instance of an editor exists by the<br />

given name, and if the instance has a valid 'editor'<br />

property.<br />

isInstalled property boolean If true, <strong>eWebEditPro</strong> is installed. 140<br />

isSupported property boolean If true, <strong>eWebEditPro</strong> is supported in this<br />

environment. It may not be installed yet.<br />

load method Loads content into all in-line editors on page from<br />

standard HTML elements with the same name.<br />

onbeforeedit event Occurs when the onbeforeedit method is invoked. 150<br />

onbeforeload event Occurs when the load method is invoked. 150<br />

onbeforesave event Occurs when the save method is invoked. 150<br />

oncreate event Occurs when the create method is invoked. 149<br />

oncreatebutton event Occurs when the createButton method is invoked. 149<br />

onedit event Occurs after the popup window closes. 150<br />

onerror event Occurs when an error occurs because the save<br />

method failed.<br />

onload event Occurs when the load method is complete. 151<br />

onready event Occurs when it is safe to send commands or access<br />

the Media File Object.<br />

onsave event Occurs when the save method is complete. 151<br />

<strong>Ektron®</strong> <strong>eWebEditPro</strong> Developer’s <strong>Reference</strong> <strong>Guide</strong>, Release 5.1, Revision 1 5<br />

Details<br />

139<br />

43<br />

48<br />

53<br />

140<br />

76<br />

141<br />

82<br />

152<br />

152

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!