ToolBarButton

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Component

  • Component

    • BindableComponent

      • ToolBarButton

Represents an item in the ToolBar.

public class ToolBarButton : BindableComponent, ICommandSource

Public Class ToolBarButton
    Inherits BindableComponent
    Implements ICommandSource

Change the type of item to display using the Style property.

Constructors

ToolBarButton()

Initializes a new instance of the ToolBarButton class.

ToolBarButton(text)

Initializes a new instance of the ToolBarButton class and displays the assigned text on the button.

Properties

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)

String: Sets the appearance key for the theme engine. (Default: null)

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 blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while ShowLoader blocks the specific widget when returning from the request.

ICommand: Returns or sets the ICommand implementation to invoke. (Default: null)

ContextMenu: Returns or sets the menu to be displayed in the drop-down toolbar button. (Default: null)

Boolean: Returns or sets whether the button is enabled. (Default: True)

Color: Returns or sets the text color of the toolbar button.

Image: Returns or sets the image that is displayed in a ToolBarButton.

Int32: Returns or sets the index value of the image assigned to the ToolBarButton. (Default: -1)

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the name of the image assigned to the button. (Default: "")

String: Returns or sets the theme name or URL for the image to display in the ToolBarButton.

Padding: Returns or sets the space between toolbar buttons.

String: Returns or sets the name of the ToolBarButton.

Padding: Returns or sets padding within the toolbar button.

ToolBar: Returns the toolbar control that the toolbar button is assigned to.

Boolean: Returns or sets whether a toggle-style toolbar button is currently in the pushed state. (Default: False)

ToolBarButtonSizeMode: Returns or sets how the toolbar button is resized. (Default: Auto)

ToolBarButtonStyle: Returns or sets the style of the toolbar button. (Default: PushButton)

Object: Returns or sets the object that contains data about the toolbar button. (Default: null)

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 "<br/>".

String: Returns or sets the text that appears as a ToolTip for the button. (Default: "")

Boolean: Returns or sets whether the toolbar button is visible or hidden. (Default: True)

Methods

Generates the Click and ButtonClick events.

Updates the component on the client. Overridden to repaint the toolbar in design mode.

Events

EventHandler Fired when the control is clicked.

EventHandler Fired when the Command property value changes.

EventHandler Fired when the Pushed property value changes.

Implements