ASP.NET 3.5 and above only

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

Obout.Ajax.UI.HTMLEditor.Toolbar class

 Inheritance Hierarchy

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

Container for a collection of CommonButton objects.

Public properties

Name Description
propertyAdditionalCSS String overridable. Gets or sets the semicolon separated URL's of additioanal CSS files that should be added to the EditPanel control.
propertyAddButtons Collection<ToolbarButton.CommonButton>. Gets the toolbar's buttons added by user.
Default empty.
propertyButtonsTemplate String. Gets or sets the file name of the template with the predefined buttons. 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.)
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).
Default false.
propertyIgnoreVerticalSeparators Bool. Gets or sets a value indicating whether to ignore vertical separators.
Default false.
propertyPopupHolderID String. Gets or sets the associated Popup Holder ID.

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

See online example.
propertyStyleFile String. Gets or sets a style file path.

Example:
myToolbar.StyleFile = "~/GlobalStyles/MyToolbar.css"
propertyTemplatesFolder String. Gets or sets the Url of the default templates folder.
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.

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.
Default empty.

"Boys… You are the best ones."

Alvaro Torres Tatis

Random testimonial   All testimonials