ASP.NET 3.5 and above only

Obout.Ajax.UI Controls - HTML Editor - Server side

Obout.Ajax.UI.HTMLEditor.EditorTopToolbar class

 Inheritance Hierarchy

<%@ Register Assembly="Obout.Ajax.UI" Namespace="Obout.Ajax.UI.HTMLEditor" TagPrefix="obout" %>

The top toolbar that is used in the Editor control.
It also can be used as a separate control, see online example.

Public properties

Name Description
propertyAdditionalCSS String sealed. Gets or sets the semicolon separated URL's of additioanal CSS files that should be added to the EditPanel control. (Inherited from Toolbar.)
Always String.Empty here.
propertyAddButtons Collection<ToolbarButton.CommonButton>. Gets the toolbar's buttons added by user. (Inherited from Toolbar.)
Default empty.
propertyAppearance Obout.Ajax.UI.HTMLEditor.EditorTopToolbar.AppearanceType enumeration. Toolbar buttons set type. All possible values of the property:
  • Full - Full buttons set
  • Lite - Lite buttons set
  • Custom - Custom buttons set
Default Full.

See online example.

Note Note
The property is ignored if the ButtonsTemplate property is set.
propertyButtonsTemplate String. Gets or sets the file name of the template with the predefined buttons. (Inherited from Toolbar.)
All buttons described in this template will be used as predefined buttons.

Example:
ButtonsTemplate="~/App_Obout/HTMLEditor/XML/ButtonsSet1.xml"

If the file extension is absent then .xml extension will be used by default.

Example:
ButtonsTemplate="~/App_Obout/HTMLEditor/XML/ButtonsSet1"

Also you can use the file name only without path prefix. In this case the value of the TemplatesFolder property will be used as the path prefix (default "~/App_Obout/HTMLEditor/XML/").

Example:
ButtonsTemplate="ButtonsSet1"

Example of the template XML file:

<PredefinedButtons>

<!-- Predefinded buttons for the toolbar -->

<button name="ButtonsGroup" ><collection name="Buttons">

<button name="Bold" />

<button name="Italic" />

<button name="HorizontalSeparator" />

</collection></button>

<button name="ButtonsGroup" ><collection name="Buttons">

<button name="Undo" />

<button name="Redo" />

<button name="HorizontalSeparator" />

</collection></button>

<button name="SpellCheck" />

<button name="HorizontalSeparator" />

<button name="CustomToolbarButton.InsertDate" />

<button name="TextIndicator" />

</PredefinedButtons>
propertyClientID String. Gets the server control identifier generated by ASP.NET. (Inherited from Control.)
propertyCssClass String. Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)

See online example.
propertyEditPredefinedButtons Collection<ToolbarButton.CommonButton>. Gets the buttons to be edited in the predefined buttons set.
Default empty.

See online example.
propertyID String. Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
propertyIgnoreTab Bool. Gets or sets a value indicating whether to ignore the default 'Tab' key navigation for all buttons (tabIndex = -1). (Inherited from Toolbar.)
Default false.
propertyIgnoreVerticalSeparators Bool. Gets or sets a value indicating whether to ignore vertical separators. (Inherited from Toolbar.)
Default false.
propertyPopupHolderID String. Gets or sets the associated Popup Holder ID. (Inherited from Toolbar.)

See online example.
propertyPreservePlace Bool. Gets or sets a value indicating whether to preserve buttons' space when invisible. (Inherited from Toolbar.)
Default false.

See online example.
propertyRemovePredefinedButtons Collection<ToolbarButton.CommonButton>. Gets the buttons to be removed from the predefined buttons set.
Default empty.

See online example.
propertyStyleFile String. Gets or sets a style file path. (Inherited from Toolbar.)

Example:
myToolbar.StyleFile = "~/GlobalStyles/MyToolbar.css"
propertyTemplatesFolder String. Gets or sets the Url of the default templates folder. (Inherited from Toolbar.)
Default "~/App_Obout/HTMLEditor/XML/"

Public methods

Name Description
property Collection<ToolbarButton.CommonButton> GetButtonsByType(Type type) Gets a collection of buttons in this toolbar with the specified type. (Inherited from Toolbar.)

See online example.

Protected properties

Name Description
propertyPopupHolder Obout.Ajax.UI.HTMLEditor.PopupHolder overridable. Gets or sets the associated Popup Holder control.
propertyPredefinedButtons Collection<ToolbarButton.CommonButton>. Gets the toolbar's predefined buttons. (Inherited from Toolbar.)
This collection dependes on the Appearance property.

"That does the trick! Thank you very much for helping resolve this issue so quickly! Much appreciated!"

Ashar Zaman
Deloitte Consulting

Random testimonial   All testimonials

Products Downloads