ButtonBase

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ButtonBase

Implements the basic functionality common to button controls.

C#

public class ButtonBase : Control, IImage, ICommandSource

VB.NET

Public Class ButtonBase
    Inherits Control
    Implements IImage, ICommandSource

Constructors

ButtonBase()

Initializes a new instance of the ButtonBase class.

Properties

AllowHtml

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

Newlines (CRLF) are converted to <BR/> when AllowHtml is false, or when AllowHtml is true and the text doesn't contain any HTML.

AllowMarkdown

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

AutoEllipsis

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the button, denoting that the text extends beyond the size of the button. (Default: False)

AutoShowLoader

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.

AutoSize

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False)

CharacterCasing

CharacterCasing: Returns or sets the case of the text to display to the user. (Default: Normal)

Command

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

DefaultSize

Size:

Image

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

ImageAlign

ContentAlignment: Returns or sets the alignment of the image in the button control. (Default: MiddleCenter)

ImageIndex

Int32: Returns or sets the image list index value of the image in the ImageList displayed in the button control. (Default: -1)

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

ImageKey

String: Returns or sets the key accessor for the image in the ImageList displayed in the button control. (Default: "")

ImageList

ImageList: Returns or sets the ImageList that contains the Image displayed in a button control. (Default: null)

ImageSource

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

IsDefault

Boolean: Returns or sets whether the button control is the default button.

Text

String: Returns or sets the text associated with this control. (Default: "")

Newlines (CRLF) are converted to <BR/> when AllowHtml is false, or when AllowHtml is true and the text doesn't contain any HTML.

TextAlign

ContentAlignment: Returns or sets the alignment of the text in the button control. (Default: MiddleCenter)

TextImageRelation

TextImageRelation: Returns or sets the position of text and image relative to each other. (Default: ImageBeforeText)

UseMnemonic

Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control. (Default: True)

Methods

OnClick(e)

Fires the Click event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnCommandChanged(e)

Fires the CommandChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnTextChanged(e)

Parameter	Type	Description
e	EventArgs

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

PerformClick()

Generates a Click event for a button.

Events

CommandChanged

EventHandler Fired when the Command property value changes.

Inherited By

Name	Description
Button	Represents a button control.
CheckBox	Represents a check box control.
RadioButton	Enables the user to select a single option from a group of choices when paired with other RadioButton controls.
SplitButton	Represents a split button control.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
ICommandSource	Defines an object that can invoke a Command.
IDropTarget	Controls that support drag & drop operations implement this interface.
IImage	Provides access to common image properties across the controls that implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.