# ToolBarButton Namespace: **Wisej.Web** Assembly: **Wisej.Framework** (4.0.0.0) * [Component](https://docs.wisej.com/api/wisej.base/general/wisej.base.component) * [Component](https://docs.wisej.com/api/wisej.web/general/wisej.web.component) * [BindableComponent](https://docs.wisej.com/api/wisej.web/general/wisej.web.bindablecomponent) * [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton) Represents an item in the [ToolBar](https://docs.wisej.com/api/wisej.web/containers/toolbar). {% tabs %} {% tab title="C#" %} ```csharp public class ToolBarButton : BindableComponent, ICommandSource ``` {% endtab %} {% tab title="VB.NET" %} ```visual-basic Public Class ToolBarButton Inherits BindableComponent Implements ICommandSource ``` {% endtab %} {% endtabs %} Change the type of item to display using the [Style](#style) property. ## Constructors ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ToolBarButton() Initializes a new instance of the [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton) class. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ToolBarButton(text) Initializes a new instance of the [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton) class and displays the assigned text on the button. | Name | Type | Description | | -------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | **text** | [String](https://docs.microsoft.com/dotnet/api/system.string) | The text to display on the new [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton). | ## Properties ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) AllowHtml [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets a value indicating that the control can display HTML in the Text property. (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) AppearanceKey [String](https://docs.microsoft.com/dotnet/api/system.string): Sets the appearance key for the theme engine. (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) AutoShowLoader [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether the application blocks the browser with a modal mask when this button is clicked and until the server is done processing the execution request. (Default: `False`) [AutoShowLoader](#autoshowloader) blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while [ShowLoader](https://docs.wisej.com/api/general/control#showloader) blocks the specific widget when returning from the request. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Command [ICommand](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.icommand): Returns or sets the [ICommand](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.icommand) implementation to invoke. (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DropDownMenu [ContextMenu](https://docs.wisej.com/api/wisej.web/menus/wisej.web.contextmenu): Returns or sets the menu to be displayed in the drop-down toolbar button. (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Enabled [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether the button is enabled. (Default: `True`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ForeColor [Color](https://docs.microsoft.com/dotnet/api/system.drawing.color): Returns or sets the text color of the toolbar button. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Image [Image](https://docs.microsoft.com/dotnet/api/system.drawing.image): Returns or sets the image that is displayed in a [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ImageIndex [Int32](https://docs.microsoft.com/dotnet/api/system.int32): Returns or sets the index value of the image assigned to the [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton). (Default: `-1`) **Throws:** * [ArgumentOutOfRangeException](https://docs.microsoft.com/dotnet/api/system.argumentoutofrangeexception)\ The specified index is less than -1. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ImageKey [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the name of the image assigned to the button. (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ImageSource [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the theme name or URL for the image to display in the [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Margin [Padding](https://docs.wisej.com/api/wisej.web/general/wisej.web.padding): Returns or sets the space between toolbar buttons. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Name [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the name of the [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Padding [Padding](https://docs.wisej.com/api/wisej.web/general/wisej.web.padding): Returns or sets padding within the toolbar button. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Parent [ToolBar](https://docs.wisej.com/api/wisej.web/containers/toolbar): Returns the toolbar control that the toolbar button is assigned to. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Pushed [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether a toggle-style toolbar button is currently in the pushed state. (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SizeMode [ToolBarButtonSizeMode](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbuttonsizemode): Returns or sets how the toolbar button is resized. (Default: `Auto`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Style [ToolBarButtonStyle](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbuttonstyle): Returns or sets the style of the toolbar button. (Default: `PushButton`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Tag [Object](https://docs.microsoft.com/dotnet/api/system.object): Returns or sets the object that contains data about the toolbar button. (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Text [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the text displayed on the toolbar button. (Default: `""`) When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "\
". ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ToolTipText [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the text that appears as a ToolTip for the button. (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Visible [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether the toolbar button is visible or hidden. (Default: `True`) ## Methods ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) Dispose(disposing) Releases the resources used by the [ToolBarButton](https://docs.wisej.com/api/wisej.web/containers/toolbar/wisej.web.toolbarbutton). | Parameter | Type | Description | | ------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------- | | **disposing** | [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) | true when this method is called by the application rather than a finalizer. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnAddReferences(items) Returns a collection of referenced components or collection of components. | Parameter | Type | Description | | --------- | ----------------------------------------------------------------------- | ----------- | | **items** | [IList](https://docs.microsoft.com/dotnet/api/system.collections.ilist) | | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) OnClick(e) Fires the [Click](#click) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | An [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnCommandChanged(e) Fires the [CommandChanged](#commandchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnPushedChanged(e) Fires the [PushedChanged](#pushedchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnWebRender(config) Renders the client component. | Parameter | Type | Description | | ---------- | ------------------------------------------------------------- | ----------------------------- | | **config** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | Dynamic configuration object. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) PerformClick() Generates the [Click](#click) and [ButtonClick](https://docs.wisej.com/api/wisej.web/containers/toolbar/..#buttonclick) events. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Update() Updates the component on the client. Overridden to repaint the toolbar in design mode. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) ValidateActiveControl() Validates the current control. **Returns:** [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean). true if the active control is validated. ## Events ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Click [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the control is clicked. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) CommandChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [Command](#command) property value changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) PushedChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [Pushed](#pushed) property value changes. ## Implements | Name | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | [IUserData](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.iuserdata) | Provides access to the `UserData` and `Tag` properties associated to the component implementing this interface. | | [IBindableComponent](https://docs.wisej.com/api/wisej.web/data-binding/wisej.web.ibindablecomponent) | Bindable components implement this interface. | | [ICommandSource](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.icommandsource) | Defines an object that can invoke a [Command](https://docs.wisej.com/api/interfaces/wisej.web.icommandsource#command). | | [IWisejComponent](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | | [IWisejSerializable](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself. |