Chapter III. Reference
Prev | 3. User Interface Configuration | Next

## 3. User Interface Configuration

### 3.1. Structure

uiconfig

Description:

  Wrapper for the elements `actions` , `menubar` and `contextmenu` which in turn group the other elements of the user interface configuration file.

Parent:

  None.

Children:

  `actions, menubar, contextmenu`

Attributes:

  `iconstyle (classic|modern) #IMPLIED`

  Determines the icon set that is used in the editor. There are two icon sets: classic and modern. The default is "classic".

Example:

      <uiconfig iconstyle="modern"> ... </uiconfig>

#### 3.1.1. Elements Defining Actions

actions

Description:

  Wrapper for the elements `action` , `actionurl` and `actionjs` which allow the definition of custom actions or the overwriting of default actions.

Parent:

  `uiconfig`

Children:

  `action, actionurl, actionjs`

Attributes:

  ``defaultshortcuts (enabled|disabled) "enabled"``

  If `defaultshortcuts` is set to "disabled", the default keyboard shortcuts of all editor actions are disabled.

Example:

      <actions> <action id="REDO" /> </actions>

action

Description:

  Allows to define a custom action or to overwrite a default action.

Parent:

  `actions`

Children:

  `shortcut`

Attributes:

  `id CDATA #REQUIRED`

  Determines the unique id of the action. This id will be used by a toolbar button, pull down menu item or context menu item to refer to this action.

  `icon CDATA #IMPLIED`

  Indicates the location of an icon which will be used to display this action in the pull down menu, the toolbar and the context menu. The path may be relative to the editor's codebase.

  `class CDATA #IMPLIED`

  Indicates a custom Java class to be called when this action is fired.

  `enabledinsourceview (true|false) "false"`

  Determines whether the action will be enabled in source view or not.

  ### Note:

  The default actions defined in edit-on Pro may have no effect in source view. The actions available per default were implemented with attention to the WYSIWYG mode only.

  `enabledinreadonlymode (true|false) "false"`

  Determines whether the action will be enabled when the editor is in read-only mode view or not.

  `enabled (true|false) "true"`

  Determines whether the action is enabled.

  ``defaultshortcut (enabled|disabled) "enabled"``

  If `defaultshortcut` is set to "disabled", the default keyboard shortcuts of the corresponding editor action are disabled.

  `alwaysenabledinwysiwyg (true|false) "false"`

  Determines whether the action is always enabled in WYSIWYG mode. If set to true, the action is even active when the caret is placed within read-only elements, or if the editor is in read-only mode.

Example:

      <action id="REDO" icon="icons/templatepicker.gif"
          class="com.realobjects.customdialogs.templatepicker.TemplatePicker"
          enabledinsourceview="false">
          <shortcut id="control Z" default="true" />
      </action>

actionjs

Description:

  Allows to define a custom JavaScript action.

Parent:

  `actions`

Children:

  `shortcut, parameterjs`

Attributes:

  `id CDATA #REQUIRED`

  Determines the unique id of the action. This id may be used by a tool bar button, pull down menu item or context menu item to refer to this action.

  `icon CDATA #IMPLIED`

  Indicates the location of an icon which will be used to display this action in the pull down menu, the toolbar or the context menu. The path may be relative to the editor's codebase.

  `jsfunction CDATA #REQUIRED`

  The name of a JavaScript function to be called when this action is fired. The function must be defined in the web page containing the editor. The specified function will receive a reference to the editor as first parameter to facilitate the communication with the editor.

  `enabledinsourceview (true|false) "false"please`

  Determines whether the action is enabled in source view or not.

  `enabled (true|false) "true"`

  Determines whether the action is enabled.

Example:

      <actionjs id="INSERTDATE" jsfunction="insertDate">
          <shortcut id="control ." default="true" />
      </actionjs>

parameterjs

Description:

  Allows to define a parameter that will be receiced by the JavaScript function specified in its parent `jsaction` element.

Parent:

  `actions`

Children:

  `shortcut, parameterjs`

Attributes:

  `parameter CDATA #REQUIRED`

  Specifies a parameter that will be received by the JavaScript function specified in its parent `jsaction` element. The first parameter received by the JavaScript function will always be a reference to the editor, this means additional parameters passed via `parameterjs` will passed as second, third, etc. parameters.

Example:

      <actionjs id="INSERTDATE" jsfunction="insertDate">
          <parameterjs parameter="2004-09-16" />
      </actionjs>

actionurl

Description:

  Allows to define an action opening an URL when fired.

Parent:

  `actions`

Children:

  `shortcut`

Attributes:

  `id CDATA #REQUIRED`

  Determines the unique id of the action. This id may be used by a toolbar button, pull down menu item or context menu item to refer to this action.

  `icon CDATA #IMPLIED`

  Indicates the location of an icon which will be used to display this action in the pull down menu, the toolbar or the context menu. The path may be relative to the editor's codebase.

  `target CDATA #IMPLIED`

  Determines the target frame in which the URL will be opened.

  `url CDATA #REQUIRED`

  Specifies the URL that will be opened when the action is fired.

  `enabledinsourceview (true|false) "false"`

  Determines whether the action is enabled in source view or not.

  `enabled (true|false) "true"`

  Determines whether the action is enabled at all.

Example:

      <actionurl id="ROWEBSITE"
          url="http://www.realobjects.com"
          target="_new" />

shortcut

Description:

  Allows to define a shortcuts for an action. The shortcuts will fire the action when they are used.

Parent:

  `action, actionjs, actionurl`

Children:

  None.

Attributes:

  `id CDATA #REQUIRED`

  Specifies a keystroke combination for the shortcut.

  `default (true|false) "false"`

  If multiple shortcuts are defined for an action, only the default shortcut will be displayed in the editor menus.

Example:

      <shortcut id="control Z" default="true" />

dragndropaction

Description:

  Allows to specify the action that will handle drag & drop events.

Parent:, please

  `actions`

Attributes:

  `actionid CDATA #REQUIRED`

  Specifies the action that will handle drag & drop events.

Example:

      <dragndropaction actionid="DRAGNDROPWITHFILTER" />

#### 3.1.2. Elements Defining the Pull Down Menu and Context Menu

menubar

Description:

  Wrapper for the `menu` elements which define the individual menus available in the pulldown menu's menubar.

Parent:

  `uiconfig`

Children:

  `menu`

Attributes:

  None.

Example:

      <menubar>
          <menu localeid="&amp;File">
              <menuitem actionid="NEW" />
          </menu>
          <menu localeid="&amp;Edit">
              <menuitem actionid="COPY"/>
          </menu>
      </menubar>

menu

Description:

  Defines a menu in either the context menu or the pull down menu. A menu may contain other menus as well as separators and menu items.

Parent:

  `menubar, menu, contextmenu`

Children:

  `menu, menuitem, separator`

Attributes:

  `localeid CDATA #IMPLIED`

  The editor will search for this `localeid` in the locale specified by the `locale` or `localeurl` property and display the corresponding `locale` string. If no corresponding `localeid` can be found, the `localeid` is displayed textually. If this attribute is not specified, the editor will display a default localized version of the menu depending on the locale is used.

  ### Note:

  "&amp;" can be used within `localeid` to specify a mnemonic for the corresponding menu or menuitem.

Example:

      <menu localeid="&amp;File">
          <menuitem actionid="NEW"/>
          <menuitem actionid="LOAD"/>
          <menuitem actionid="OPENFILE"/>
          <separator/>
          <menuitem actionid="DOCSTAT"/>
      </menu>

menuitem

Description:

  Defines a menuitem inside a menu.

Parent:

  `menu`

Children:

  None.

Attributes:

  `localeid CDATA #IMPLIED`

  The editor will search for this `localeid` in the locale specified by the `locale` or `localeurl` property and display the corresponding `locale` string. If no corresponding `localeid` can be found, the `localeid` is displayed textually. If this attribute is not specified, the editor will display a default localized version of the menu item depending on the locale that is used.

  `actionid CDATA #REQUIRED`

  Determines the id of the action that is fired when the menuitem is clicked.

Example:

      <menuitem localeid="&amp;New" actionid="NEW"/>

separator

Description:

  Defines a separator inside a menu or the toolbar.

Parent:

  `menu | toolbar`

Children:

  None.

Attributes:

  None.

Example:

      <separator />

#### 3.1.3. Elements Defining The Toolbar

toolbar

Description:

  Defines the editor's toolbar.

Parent:

  `uiconfig`

Children:

  `button, buttongroup, choice, separator, endrow`

Attributes:

  `collapse (true|false) "false"`

  Specifies whether the toolbar is collapsed to one line after the editor is initialized. The toolbar may be expanded manually.

  `classicbuttonstyle (true|false)`

  Specifies whether toolbar buttons are painted by Swing or by edit-on Pro. If set to true, the buttons are painted by Swing.

Example:

      <toolbar collapse="false"
          classicbuttonstyle="false">
          <button localeid="New" actionid="NEW" enabled="true"/>
          <button localeid="Open" actionid="LOAD"/>
          <separator/>
          <button localeid="Cut" actionid="CUT"/>
      </toolbar>

button

Description:

  Defines a toolbar button.

Parent:

  `toolbar`

Children:

  None.

Attributes:

  `localeid CDATA #IMPLIED`

  The editor will search for this `localeid` in the locale specified by the `locale` or `localeurl` property and display the corresponding `locale` string. If no corresponding `localeid` can be found, the `localeid` is displayed textually. If this attribute is not specified, the editor will display a default localized version of the button name depending on the locale that is used.

  `actionid CDATA #REQUIRED, please`

  Determines the id of the action that is fired when the menuitem is clicked.

Example:

      <button actionid="CUT" />

buttongroup

Description:

  Specifies a special button type which functions like a normal button `element` . Additionally, the `buttongroup` has a small arrow selector allowing the user to select one out of multiple `subbutton` buttons.

Parent:

  `toolbar`

Children:

  `subbutton`

Attributes:

  `localeid CDATA #IMPLIED`

  The editor will search for this `localeid` in the locale specified by the `locale` or `localeurl` property and display the corresponding `locale` string. If no corresponding `localeid` can be found, the `localeid` is displayed textually. If this attribute is not specified, the editor will display a default localized version of the button name depending on the locale that is used.

  `actionid CDATA #REQUIRED`

  Determines the id of the action that is fired when the menuitem is clicked.

Example:

      <buttongroup localeid="Ordered List" actionid="ORDEREDLIST">
          <subbutton localeid="Lower Alpha Orderedlist" actionid="LOWERALPHAORDEREDLIST"/>
          <subbutton localeid="Upper Alpha Orderedlist" actionid="UPPERALPHAORDEREDLIST"/>
          <subbutton localeid="Number Alpha Orderedlist" actionid="NUMBERALPHAORDEREDLIST"/>
      </buttongroup>

subbutton

Description:

  Specifies a button being displayed after clicking on the arrow selector of the parent `buttongroup` .

Parent:

  `buttongroup`

Children:

  None.

Attributes:

  `localeid CDATA #IMPLIED`

  The editor will search for this `localeid` in the locale specified by the `locale` or `localeurl` property and display the corresponding `locale` string. If no corresponding `localeid` can be found, the `localeid` is displayed textually. If this attribute is not specified, the editor will display a default localized version of the button name depending on the locale used.

  `actionid (DISCUNORDEREDLIST | CIRCLEUNORDEREDLIST | SQUAREUNORDEREDLIST | UPPERALPHAORDEREDLIST | LOWERALPHAORDEREDLIST | NUMERICORDEREDLIST | LOWERROMANORDEREDLIST | UPPERROMANORDEREDLIST) #REQUIRED`

  Determines the id of the action fired when the menuitem is clicked. Only ordered lists or unordered lists can be `subbutton` elements.

  `enabled (true|false) "true"`

  Determines whether the button is enabled.

Example:

      <subbutton localeid="Number Alpha Orderedlist"
          actionid="NUMERICORDEREDLIST" />

choice

Description:

  Defines a toolbar combo box.

Parent:

  `toolbar`

Children:

  None.

Attributes:

  `localeid CDATA #IMPLIED`

  The editor will search for this `localeid` in the locale specified by the `locale` or `localeurl` property and display the corresponding `locale` string. If no corresponding `localeid` can be found, the `localeid` is displayed textually. If this attribute is not specified, the editor will display a default localized version of the combo box name depending on the locale that is used.

  `actionid (FONTSIZE|FONTTYPE|STYLESHEET|PARAGRAPHSTYLE) #REQUIRED`

  Determines the id of the action that is fired when the menuitem is clicked.

  `width CDATA #IMPLIED`

  Determines the width of the combo box.

  `fontsize CDATA #REQUIRED`

  Determines the font size that is used in the combo box.

Example:

      <choice localeid="Paragraph Style"
          actionid="PARAGRAPHSTYLE"/>

customchoice

Description:

  May be used to specify a custom drop down box within the editor's toolbar. The drop down box groups several default editor actions as well as custom actions.

Parent:

  `config`

Children:

  `customchoiceitem`

Attributes:

  `localeid CDATA #REQUIRED | fontsize CDATA #IMPLIED`

  Determines a custom drop down box. The required attribute `localeid` defines the tooltip, `fontsize` sets the font size of the elements displayed within the drop down box.

Example:

      <customchoice localeid="Custom choice tooltip"
          fontsize="20">

customchoiceitem

Description:

  Adds the specified editor action or custom action to the `customchoice` toolbar drop down box

Parent:

  `customchoice`

Children:

  None.

Attributes:

  `actionid CDATA #REQUIRED | localeid CDATA #IMPLIED`

  The attribute `actionid` determines the ACTIONID which should be listed in the drop down box. `localeid` changes the default label for respective ACTIONID within the drop down box.

Example:

      <customchoiceitem actionid="BOLD" localeid="Format Bold"/>

endrow

Description:

  May be used to specify the end of a row in the toolbar. If no `endrow` elements are used, the editor will determine automatically where to wrap the toolbar.

Parent:

  `toolbar`

Children:

  None.

Attributes:

  None.

Example:, please

      <endrow />

### 3.2. Actions

ACCEPTALL

Description:

  Accepts all changes in the document. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

ACCEPTDELETION

Description:

  Accepts a deletion at the caret position. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

ACCEPTFORMAT

Description:

  Accepts a formatting change at the caret position. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

ACCEPTINSERTION

Description:

  Accepts an insertion at the caret position. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

ACCEPTALLSELECTEDCHANGES

Description:

  Accepts all changes within the current selection. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

ACRONYM

Description:

  Opens the "Insert Acronym" dialog.

ACRONYMPROPERTIES

Description:

  Opens the "Acronym Properties" dialog.

ADVANCEDORDEREDLIST

Description:

  Allows the user to select one of the available ordered list types.

ADVANCEDREDO

Description:

  Proposes a list of undone actions that can be redone.

ADVANCEDSTYLESHEET

Description:

  Provides a list of CSS styles to select from. The selected CSS style is applied to the current element or selection. Additionally, the list displays to which elements the individual styles can be applied to.

ADVANCEDUNDO

Description:

  Proposes a list of actions that can be undone.

ADVANCEDUNORDEREDLIST

Description:

  Allows the user to select one of the available unordered list types.

ALIGNLEFT

Description:

  Aligns the current element or selection on the left.

ALIGNCENTER

Description:

  Aligns the current element or selection at the center.

ALIGNJUSTIFY

Description:

  Justifies the current element or selection.

ALIGNRIGHT

Description:

  Aligns the current element or selection on the right.

AUTOSPELLCHECK

Description:

  Enables / disables real-time spell-checking.

AUTOSPELLCHECKSUGGESTION

Description:

  Provides a list of correction suggestions if the word at the cursor position was not recognized by the spell checker.

  ### Note:

  This action may only be used in the context menu.

BLOCKQUOTE

Description:

  Opens the "Insert Blockquote" dialog.

BLOCKQUOTEPROPERTIES

Description:

  Opens the "Blockquote Properties" dialog.

BOLD

Description:

  Makes the selection bold and enables typing of bold text.

BOOKMARK

Description:

  Opens the "Insert Bookmark" dialog.

BOOKMARKPROPERTIES

Description:

  Opens the "Edit Bookmark Properties" dialog if the current element or selection is a bookmark.

BR

Description:

  Inserts a line break (<br />) at the current caret position.

CDATAPROPERTIES

Description:

  Opens the "Edit CDATA" dialog if the current element or selection is a CDATA section.

CELLPROPERTIES

Description:

  Opens the "Cell Properties" dialog if the current element or selection is a table cell.

CIRCLEUNORDEREDLIST

Description:

  Displays a list with each member of the list marked with a circle.

CHANGECASE

Description:

  Opens the "Change case" dialog.

CLEAN

Description:

  Removes formatting from the current selection.

COLOR

Description:

  Opens the "Font Color" dialog.

COLUMNPROPERTIES

Description:

  Opens the "Column Properties" dialog if the current element or selection is a table column.

COMMENT

Description:

  Opens the "Insert Comment" dialog.

  The inserted comment will only be visible in WYSIWYG mode if the "Show All" option (P-mode) is enabled.

COMMENTPROPERTIES

Description:

  Opens the "Edit Comment" dialog if the current element or selection is a comment.

CONTEXTMENU

Description:

  Opens the context menu.

CONVERTTABLEWIDTHTORELATIVE

Description:

  Converts the table at the caret position to a table with relative width.

COPY

Description:

  Copies the current selection to the clipboard.

CUT

Description:

  Cuts the current selection and inserts it into the clipboard.

DECINDENT

Description:

  Decreases the indentation of a paragraph or list element.

DELETECOLUMN

Description:

  Deletes the table column at the cursor position.

DELETETABLE

Description:

  Deletes the table at the cursor position.

DIFF

Description:

  Opens the "Compare Documents" dialog which allows the user to select two documents for comparison. Once the documents are loaded, the editor runs in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

DIFFLIST

Description:

  Opens the "Diff List" dialog which displays all modifications found in the document in a list.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

DISCUNORDEREDLIST

Description:

  Displays a list with each member of the list marked with a disc.

DOCSTAT

Description:

  Opens the "Document Statistics" dialog.

ENDENCLOSINGBLOCK

Description:

  Ends the enclosing block. That is, if the caret is within a `blockquote`, `div`, `ol` or `ul` element, a new `p` element is inserted after this element, and the caret is placed within the newly inserted `p` element.

FIND

Description:

  Opens the "Find and Replace" dialog.

HIGHLIGHTTEXT

Description:

  Opens a dialog whicht lets the user select a highlight color for the current selection and enables typing of highlighted text.

FONTSIZE

Description:

  Provides a list of font sizes to select from. The selected font size is applied to the current selection.

FONTTYPE

Description:

  Provides a list of font styles to select from. The selected font style is applied to the current selection.

GOTONEXTBOOKMARK

Description:

  Sets the caret at the end of the next bookmark found in the document starting from the caret position.

GOTOPREVIOUSBOOKMARK

Description:

  Sets the caret at the end of the previous bookmark found in the document starting from the caret position.

HARDRULERPROPERTIES

Description:

  Opens the "Horizontal Line Properties" dialog if the current element or selection is a hard ruler.

HELP

Description:

  Opens the online help in a new browser window.

### Note:

Integrators/developers of course can modify the help files according to the individual need of their installation. Upon request RealObjects will also provide the related DocBook files and style sheets.

HR

Description:

  Inserts a hard ruler at the cursor position.

IMAGE

Description:

  Opens the "Insert Image" dialog.

IMAGEPROPERTIES

Description:

  Opens the "Image Properties" dialog if the current element or selection is an image.

INFO

Description:

  Opens the "Info" dialog.

INCINDENT

Description:

  Increases the indentation of a paragraph or list element.

INLINEQUOTE

Description:

  Opens the "Insert Inline Quote" dialog.

INLINEQUOTEPROPERTIES

Description:

  Opens the "Inline Quote Properties" dialog.

INSERTCOLUMN

Description:

  Opens the "Insert Column" dialog if the cursor is inside a table.

INSERTCUSTOMTAG

Description:

  Opens the "Insert Custom Tag" dialog.

INSERTDATETIME

Description:

  Opens the "Insert date and time" dialog.

INSERTLANG

Description:

  Opens the "Insert Language Attribute" dialog. This dialog inserts a `span` element with a "lang" attribute around the selected content. The value of the "lang" attribute is the value specified by the dialog

INSERTROW

Description:

  Opens the "Insert Row" dialog if the cursor is inside a table.

INSERTSPAN

Description:

  Opens the "Insert Span" dialog.

INSERTTABLE

Description:

  Inserts a default table at the cursor position.

INSERTTABLEDIALOG

Description:

  Opens the "Insert Table Dialog".

INSERTTABLEWIZARD

Description:

  Opens the "Insert Table Wizard".

ITALIC

Description:

  Makes the selection italic and enables typing of italic text.

LANGPROPERTIES

Description:

  Opens the "Edit Language Attribute" dialog if the caret is located in a `span` tag having a "lang" attribute.

LISTPROPERTIES

Description:

  Opens the "List Properties" dialog.

LINK

Description:

  Opens the "Insert Hyperlink" dialog.

LINKPROPERTIES

Description:

  Opens the "Edit Hyperlink" dialog if the current element or selection is a hyperlink.

LOAD

Description:

  Opens the "Open URL" dialog.

LOWERALPHAORDEREDLIST

Description:

  Displays an ordered list with each member of the list marked with a lowercase type ('a').

LOWERROMANORDEREDLIST

Description:

  Displays a list with each member of the list is marked with a lowercase Roman number ('iv'').

MERGECELLABOVE

Description:

  Merges the table cell at cursor position with the cell above it.

MERGECELLBELOW

Description:

  Merges the table cell at cursor position with the cell below it.

MERGECELLLEFT

Description:

  Merges the table cell at cursor position with the cell at the left.

MERGECELLRIGHT

Description:

  Merges the table cell at cursor position with the cell at the right.

NEW

Description:

  Clears the editor's content and populates the editor with a template or default document.

NEXTDIFF

Description:

  Jumps to the next modification found in the document.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

NUMERICORDEREDLIST

Description:

  Displays an ordered list with each member of the list marked with an Arabic number ('1').

OBJECT

Description:

  Opens the "Insert Object" dialog.

OBJECTPROPERTIES

Description:

  Opens the "Image Properties" dialog if the current element or selection is an image.

OPENFILE

Description:

  Opens the file chooser dialog.

ORDEREDLIST

Description:

  Displays a list where each member of the list is marked with an Arabic number ('1'). Additionally allows the user to select one of the three available ordered list types.

PAGEPROPERTIES

Description:

  Opens the "Page Properties" dialog, which allows to specify properties for the document currently being edited, such as the document title, the default color of hyperlinks and a background image for the document.

PARAGRAPHSTYLE

Description:

  Provides a list of paragraph styles to select from. The selected paragraph style is applied to the current selection.

PASTE

Description:

  Inserts the contents of the clipboard in HTML format with style information contained inline.

PASTEPLAINTEXT

Description:

  Inserts the contents of the clipboard without any formatting or styles.

PASTESPECIAL

Description:

  Opens the "Paste Special" dialog. This dialog lets the user select which type of paste to perform (e.g plain text only, or in HTML but without styles etc.) and will give a short overview over what each type of paste will result in.

PASTEWITHFILTER

Description:

  Inserts the contents of the clipboard in HTML format, but without styles.

PASTEWITHSTYLEDEFS

Description:

  Inserts the contents of the clipboard in HTML format with style information contained in an embedded style sheet, e.g.converts inline styles to style classes. Imported styles will be merged with existing styles respectively style classes.

PIPROPERTIES

Description:

  Opens the "Edit Processing Instruction" dialog if the current element or selection is a processing instruction.

PREVDIFF

Description:

  Jumps to the previous modification found in the document.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

REDO

Description:

  The last action that was performed is rolled back.

REJECTALL

Description:

  Rejects all changes within the document. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

REJECTDELETION

Description:

  Rejects a deletion at the caret position. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

REJECTFORMAT

Description:

  Rejects a formatting change at the caret position. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

REJECTINSERTION

Description:

  Rejects an insertion at the caret position. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

REJECTSELECTEDCHANGES

Description:

  Rejects all changes within the current selection. This action is only enabled in comparison mode.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

REMOVEBOOKMARK

Description:

  Removes a bookmark at the cursor position.

REMOVECUSTOMTAG

Description:

  Removes a custom tag at the cursor position. Only the custom tag itself is removed, while its content is preserved.

REMOVECUSTOMTAGWITHCONTENT

Description:

  Removes a custom tag at the cursor position. The custom tag is removed including all of its content.

REMOVELINK

Description:

  Removes a hyperlink from the current selection.

RESETIMAGESIZE

Description:

  If an image is selected or the caret is placed on an image when this action is called, the image size is reset to its orginal size if it was modified.

RESETUSERPREFS

Description:

  Resets the user preferences. The user preferences consist of the values that were last specified by the user in some dialogs such as the table properties dialog, the color properties dialog or the cell properties dialog.

ROWPROPERTIES

Description:

  Opens the "Row Properties" dialog if the current element or selection is a table row.

SAVE

Description:

  Posts the editor's content to the URL specified by the `gethtmldataurl` property.

SAVEAS

Description:

  Opens a "Save as" dialog which allows the user to save the document currently being editied locally on his computer.

SELECTALL

Description:

  Selects all content within the editor.

SHOWNALLCHAR

Description:

  Displays control characters, XML comments, CDATA sections, processing instructions and custom tags.

SHOWSOURCEVIEW

Description:

  Switches to `Source View` when it is activated and to `WYISIWYG` View when it is deactivated.

SHOWTABLEGRID

Description:

  Enables / disables the display of the table grid. If it is enabled, table borders with a width of "0" will be displayed as a dotted line. If it is disabled, borders with no width will not be displayed.

SHOWWYSIWYGAREAONLY

Description:

  Enables / disables the display of the canvas, UI and tab pane. When enabled, only the WYSIWYG area is displayed.

  ### Note:

  When this action is enabled, most of the UI is hidden. The user won't be able to use the toolbar or pull down menu to disable this action. Thus, it is recommended to provide a context menu and a keyboard shortcut for this action.

SHOWWYSIWYGVIEW

Description:

  Switches to `WYSIWYG` view when it is activated and to `Source View` when it is deactivated.

SOURCESYNTAXHIGHLIGHT

Description:

  Enables / disables syntax highglighting in source view when it is called.

SOURCELINESWRAP

Description:

  Enables / disables word wrap in source view when it is called.

SPECIALCHARACTER

Description:

  Opens the "insert Symbol" dialog.

SPELLCHECK

Description:

  Checks the spelling of the content inside the editor. If the spell checker finds one or more errors, the "Check Spelling" dialog is opened.

SPLITCELL

Description:

  Opens the "split" dialog, which allows splitting of table cells.

SPLITPARAGRAPH

Description:

  Splits the paragraph at the caret position. This has the same effect when as pressing the "enter" key when the configuration option "alternateenterkeyaction" is not set.

SQUAREUNORDEREDLIST

Description:

  Displays a list with each member of the list marked with a square.

STANDALONE

Description:

  Enables / disables the "Stand Alone" mode. In "Stand Alone" mode the editor is displayed in a separate window outside of the browser and can be freely resized by the user.

STRIKETHROUGH

Description:

  Makes the selection striked out and enables typing of striked out text.

STYLESHEET

Description:

  Provides a list of CSS styles to select from. The selected CSS style is applied to the current element.

STYLESHEETPROPERTIES

Description:

  Opens the "Style Properties" dialog.

SUBSCRIPT

Description:

  Makes the selection subscript and allows the typing of subscript text.

SUPERSCRIPT

Description:

  Makes the selection superscript and allows the typing of superscript text.

TABLEAUTOFORMAT

Description:

  Opens the "Table Autoformat" dialog if the element at the cursor position is a table. This dialog allows you to select and apply a template to a table.

TABLEPROPERTIES

Description:

  Opens the "Table Properties" dialog if the element at the cursor position is a table.

TAGPROPERTIES

Description:

  Opens the "Edit Tag Properties" dialog if the current element or selection is a custom element.

THESAURUS

Description:

  Opens the thesaurus for the word at the current caret position.

THESAURUSSUGGESTION

Description:

  Provides a list of thesaurus suggestions for the word at the current caret position for use in the context menu.

TRACKCHANGES

Description:

  Enables comparison mode in the editor. All changes made to the document currently edited are tracked from then on.

  ### Note

  This feature is only available if VersioTrack is enabled in your license.

TREEVIEW

Description:

  Opens the "Tree View" dialog. The tree view will display the position of the element at the cursor position inside the document tree.

UNDERLINE

Description:

  Underlines the selection and enables typing of underlined text.

UNDO

Description:

  The last action performed inside the editor is undone.

UNORDEREDLIST

Description:

  Displays a list with each member of the list is marked with a disc. Additionally allows the user to select one of the three available unordered list types.

UPLOADDOCUMENTIMAGES

Description:

  Opens the "Upload Document Images" dialog. The dialog allows the user to upload images to the server if the `filemanagement` element is specified in the configuration file.

  ### Important:

  This action is deprecated as of edit-on Pro version 4.2. Please use `UPLOADIMAGES` instead.

UPLOADDOCUMENT

Description:

  Opens the "Upload Document" dialog. The dialog allows the user to upload the document currently being edited to the server. To configure where the document should be uploaded to, please use the `filemanagement` setting in the configuration file.

UPLOADALL

Description:

  Successively opens the "Upload Objects" dialog and the "Upload Document" dialog. The dialogs resp. allows the user to upload images and objects and the document currently being edited. To configure where the images should be uploaded to, please use the `filemanagement` setting in the configuration file.

UPLOADIMAGES

Description:

  Opens the "Upload Images" dialog. The dialog allows the user to upload images to the server. To configure where the images should be uploaded to, please use the `filemanagement` setting in the configuration file.

UPLOADOBJECTS

Description:

  Opens the "Upload Objects" dialog. The dialog allows the user to upload objects to the server. To configure where the objects should be uploaded to, please use the `filemanagement` setting in the configuration file.

UPPERALPHAORDEREDLIST

Description:

  Displays a list with each member of the list is marked with an uppercase type ('A').

UPPERROMANORDEREDLIST

Description:

  Displays a list with each member of the list is marked with an uppercase Roman number ('IV').

Prev | Up | Next
2. JavaScript API | Home | 4. CSS Reference