Default Toolbar Items
- 3 minutes to read
ASPxHtmlEditor provides a set of default toolbar items that allow end-users to perform specific predefined actions when editing the editor’s content in the design view.
Each default toolbar item is represented by an individual class, which is a descendant of the ToolbarItemBase class. A click on a default toolbar item executes the corresponding command associated with the item using the HtmlEditorToolbarItem.CommandName property (note that this property is overridden on each toolbar item’s class level). A default toolbar item’s command name can be used to identify the item when handling the ASPxClientHtmlEditor.CommandExecuted client event. On the client side, the allowed predefined command names are listed in the ASPxClientCommandConsts object.
A default toolbar item’s visibility and visible order amongst other toolbar items can be specified using the HtmlEditorToolbarItem.Visible and HtmlEditorToolbarItem.VisibleIndex properties. The HtmlEditorToolbarItem.BeginGroup property can be used to control whether or not a toolbar item starts a group (a specific separator appears before the toolbar item in this case). Using the ToolbarItemBase.ToolTip property, a toolbar item’s tooltip text can be defined.
You can add and remove items from a toolbar at design time using the ASPxHtmlEditor Designer.
If you need to have a toolbar item that implements custom functionality, you can create a custom toolbar item.
List of Default Toolbar Items
The table below lists the default toolbar items available in the ASPxHtmlEditor, classes that correspond to the items, and client-side commands that are executed by the items.