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.

Syntax for retrieving object:<br />

<strong>eWebEditPro</strong>.instances[sEditorName].editor.Toolbars().CommandItem(sCommandName);<br />

Name API Type Return<br />

Type<br />

For more information see: “The Toolbar Object Interface” on page 194<br />

Description<br />

AddItem method none In an edit control, it sets the text. In a list box, it adds an<br />

item to the dropdown list.<br />

Clear method none In a list box, it clears all entries. In an edit box, it clears<br />

the text. In a toggle, it ensures that it is un-toggled.<br />

CmdCaption property string Retrieves the caption. 106<br />

CmdData property long Sets the current item to the entry that contains the long<br />

data value associated with the text.<br />

CmdFirst method boolean Sets the command object to look at the first command<br />

in the menu or toolbar.<br />

CmdGray property boolean The command is disabled and displayed as a grayed<br />

image.<br />

CmdIndex property integer Sets the currently selected index and retrieves the<br />

currently selected index into the list box.<br />

CmdName property string Returns the command name associated with the<br />

button.<br />

CmdNext method boolean Sets the command object to look at the next command<br />

in the menu or toolbar.<br />

CmdStyle property integer Reflects the style of the command. 107<br />

CmdText property string Sets the current selection for a list box. 107<br />

CmdToggledOn property boolean Only available to Toggle style buttons. If true, the button<br />

appears pressed in or selected. If false, it appears<br />

popped out or unselected.<br />

CmdToolTipText property string Contains the tooltip text associated with a command. 107<br />

CmdType property etbComma<br />

nd<br />

Styles<br />

The command type assigned during the creation of the<br />

command.<br />

CmdVisible property boolean Reflects the visibility of a command. If true, the user<br />

can see the command.<br />

FirstCommand method boolean Sets the current reference to the first command<br />

available.<br />

getProperty method string Reads from the ActiveX control property. 71<br />

getPropertyBoolean method boolean Returns the value of a Boolean property. 72<br />

getPropertyInteger method integer Returns the value of a numeric property. 72<br />

getPropertyString method string Returns the value of a String property. 72<br />

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

Details<br />

45<br />

49<br />

106<br />

49<br />

106<br />

106<br />

107<br />

50<br />

107<br />

107<br />

108<br />

63

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

Saved successfully!

Ooh no, something went wrong!