<toolbar> Configuration Element

<toolbar> Configuration Element
Prev	Chapter 18. XML Configuration API	Next

This element contains the configuration information for a toolbar for use within Ephox EditLive! for XML.

Items will appear in a toolbar in EditLive! for XML, from left to right, in the order that they appear in the EditLive! for XML configuration document.

Configuration Element Tree Structure

<editLive>
- <toolbars>
  - <toolbar>

<editLive>
     ...
     <toolbars>
          <toolbar ...>
               <!--toolbar configuration settings-->
          </toolbar>
     </toolbars>
     ...
</editLive>

Required Attributes

name: An identifying name for this toolbar. The value for this attribute must be unique within the collection of toolbars for EditLive! for XML.

Child Elements

<toolbarButton>: This element will cause a particular button to be present on the toolbar within EditLive! for XML.

<toolbarButtonGroup>

This element will cause a particular group of buttons to be present on the toolbar within EditLive! for XML. The operation of these buttons within EditLive! for XML will be mutually exclusive. The buttons added by this element can only be added and removed from the toolbar as a group.

For example, the alignment buttons are a button group as Align Left cannot be activated at the same time as Align Right.

<toolbarComboBox>: This element will cause a particular combo box to be present on the toolbar within EditLive! for XML.

<toolbarSeparator>: This element will cause the appearance of a vertical separating line between toolbar elements.

<customToolbarButton>: This element specifies the properties for a developer defined custom toolbar button for use within Ephox EditLive! for XML.

<customToolbarComboBox>: This element specifies the properties for a developer defined custom toolbar combo box for use within Ephox EditLive! for XML.

Example

This example demonstrates how to declare toolbars with the name command and format.

<editLive>
  ...
  <toolbars>
    ...
    <toolbar name="command">
      ...
    </toolbar>
    <toolbar name="format">
      ...
    </toolbar>
    ...
  </toolbars>
  ...
</editLive>

Remarks

Toolbars will appear in the EditLive! for XML interface in the order that they appear in the configuration file.

The <toolbar> element can appear multiple times within the <toolbars> element.

Prev	Up	Next
<toolbars> Element	Home	<toolbarButtonGroup> Element