Button

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ButtonBase
    • Button

Represents a button control.

C#

public class Button : ButtonBase, IButtonControl

VB.NET

Public Class Button
    Inherits ButtonBase
    Implements IButtonControl

Constructors

Button()

Initializes a new instance of the Button class.

Button(text, onClick)

Initializes a new instance of the Button class with specific initial settings.

Name	Type	Description
text	String	Initial text.
onClick	Action<Object, EventArgs>	Optional Click handler.

Button(text, location, size, onClick)

Initializes a new instance of the Button class with specific initial settings.

Name	Type	Description
text	String	Initial text.
location	Point	Initial location.
size	Size	Initial size.
onClick	Action<Object, EventArgs>	Optional click handler.

Button(text, ImageSource, location, size, onClick)

Initializes a new instance of the Button class with specific initial settings.

Name	Type	Description
text	String	Initial text.
ImageSource	String	Image source.
location	Point	Initial location.
size	Size	Initial size.
onClick	Action<Object, EventArgs>	Optional click handler.

Properties

AutoSizeMode

AutoSizeMode: Returns or sets the mode by which the Button automatically resizes itself. (Default: GrowOnly)

AutoToolTip

Boolean: Returns or sets whether a tooltip is displayed when the text extends beyond the size of the control. (Default: False)

The auto tooltip is set on the browser using the title attribute managed by the browser, does not use the themed tooltip managed by Wisej.NET.

BorderStyle

BorderStyle: Returns or sets the border style of the button control. (Default: Solid)

DialogResult

DialogResult: Returns or sets a value that is returned to the parent form when the button is clicked. (Default: None)

Display

Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both. (Default: Both)

ImageSpacing

Nullable<Int32>: Returns or sets the distance in pixels between the image and the label inside the button. (Default: null)

MenuItems

MenuItemCollection: Returns the collection of MenuItem objects associated with the button.

Repeat

Boolean: Enables or disables the auto-repeat feature. When enabled, the button keeps firing click events at an increasing rate while the user keeps the button pressed. (Default: False)

Shortcut

Shortcut: Returns or sets a value indicating the shortcut key associated with the button. (Default: None)

Methods

Dispose(disposing)

Disposes the control.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

OnAddReferences(items)

Adds references components to the list. Referenced components can be added individually or as a reference to a collection.

Parameter	Type	Description
items	IList	Container for the referenced components or collections.

OnBindingContextChanged(e)

Fires the BindingContextChanged event.

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

OnClick(e)

Fires the Click event.

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

OnItemClick(e)

Fires the ItemClicked event.

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

OnMenuCollapse(e)

Fires the MenuCollapse event. Since 3.5.5

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

OnMenuPopup(e)

Fires the MenuPopup event. Since 3.5.5

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

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

PerformClick()

Generates a Click event for a button.

Events

ItemClicked

MenuButtonItemClickedEventHandler Fired when the user clicks one of the drop down menu items.

MenuCollapse

EventHandler Fired when the button menu is closed. Since 3.5.5

MenuPopup

EventHandler Fired after the button menu is displayed on the client. Since 3.5.5

Inherited By

Name	Description
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.
IButtonControl	Allows a control to act like a button on a Form.
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.