Class ButtonBase

Represents the base class for all button controls, such as Button, RepeatButton, and HyperlinkButton.

Inheritance
System.Object
DependencyObject
UIElement
FrameworkElement
Control
ContentControl
ButtonBase
Button
HyperlinkButton
RepeatButton
ToggleButton
RatingItem
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Controls.Primitives
Assembly: OpenSilver.dll
Syntax
public class ButtonBase : ContentControl, IControl, IFrameworkElement, IUIElement, IDependencyObject

Constructors

| Improve this Doc View Source

ButtonBase()

Initializes a new instance of the ButtonBase class.

Declaration
public ButtonBase()

Fields

| Improve this Doc View Source

ClickModeProperty

Identifies the ClickMode dependency property.

Declaration
public static readonly DependencyProperty ClickModeProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

CommandParameterProperty

Identifier for the CommandParameter dependency property.

Declaration
public static readonly DependencyProperty CommandParameterProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

CommandProperty

Identifier for the Command dependency property.

Declaration
public static readonly DependencyProperty CommandProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

IsFocusedProperty

Identifies the IsFocused dependency property.

Declaration
public static readonly DependencyProperty IsFocusedProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

IsMouseOverProperty

Identifies the IsMouseOver dependency property.

Declaration
public static readonly DependencyProperty IsMouseOverProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

IsPressedProperty

Identifies the IsPressed dependency property.

Declaration
public static readonly DependencyProperty IsPressedProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

ClickMode

Gets or sets when the Click event occurs.

Declaration
public ClickMode ClickMode { get; set; }
Property Value
Type Description
ClickMode

When the Click event occurs. The default value Release.
| Improve this Doc View Source

Command

Gets or sets the command to invoke when this button is pressed.

Declaration
public ICommand Command { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

The command to invoke when this button is pressed. The default is null.
| Improve this Doc View Source

CommandParameter

Gets or sets the parameter to pass to the Command property.

Declaration
public object CommandParameter { get; set; }
Property Value
Type Description
System.Object

The parameter to pass to the Command property. The default is null.
| Improve this Doc View Source

IsFocused

Gets a value that determines whether the button has focus.

Declaration
public bool IsFocused { get; }
Property Value
Type Description
System.Boolean

true if the control has focus; otherwise, false. The default is false.
| Improve this Doc View Source

IsMouseOver

Gets a value indicating whether the mouse pointer is located over this button control.

Declaration
public bool IsMouseOver { get; }
Property Value
Type Description
System.Boolean

true to indicate the mouse pointer is over the button control, otherwise false. The default is false.
| Improve this Doc View Source

IsPressed

Gets a value that indicates whether a ButtonBase is currently in a pressed state.

Declaration
public bool IsPressed { get; protected set; }
Property Value
Type Description
System.Boolean

true if the ButtonBase is in a pressed state; otherwise false. The default is false.

Methods

| Improve this Doc View Source

OnApplyTemplate()

Builds the visual tree for the ButtonBase control when a new template is applied.

Declaration
public override void OnApplyTemplate()
Overrides
| Improve this Doc View Source

OnClick()

Raises the Click event.

Declaration
protected virtual void OnClick()
| Improve this Doc View Source

OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
Type Name Description
RoutedEventArgs e

The data for the event.
Overrides
| Improve this Doc View Source

OnIsPressedChanged(DependencyPropertyChangedEventArgs)

Called when the value of the IsPressed property changes.

Declaration
protected virtual void OnIsPressedChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
DependencyPropertyChangedEventArgs e

The data for DependencyPropertyChangedEventArgs.
| Improve this Doc View Source

OnKeyDown(KeyEventArgs)

Raises the KeyDown event

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
KeyEventArgs e
Overrides
| Improve this Doc View Source

OnKeyUp(KeyEventArgs)

Raises the KeyUp event

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
Type Name Description
KeyEventArgs e
Overrides
| Improve this Doc View Source

OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.

Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
Type Name Description
RoutedEventArgs e

The data for the event.
Overrides
| Improve this Doc View Source

OnLostMouseCapture(MouseEventArgs)

Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate.

Declaration
protected override void OnLostMouseCapture(MouseEventArgs e)
Parameters
Type Name Description
MouseEventArgs e

A MouseEventArgs that contains the event data.
Overrides
| Improve this Doc View Source

OnMouseEnter(MouseEventArgs)

Raises the PointerEntered event

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
Type Name Description
MouseEventArgs e
Overrides
| Improve this Doc View Source

OnMouseLeave(MouseEventArgs)

Raises the PointerExited event

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
Type Name Description
MouseEventArgs e
Overrides
| Improve this Doc View Source

OnMouseLeftButtonDown(MouseButtonEventArgs)

Raises the PointerPressed event

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
Type Name Description
MouseButtonEventArgs e
Overrides
| Improve this Doc View Source

OnMouseLeftButtonUp(MouseButtonEventArgs)

Raises the PointerReleased event

Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
Type Name Description
MouseButtonEventArgs e
Overrides
| Improve this Doc View Source

OnMouseMove(MouseEventArgs)

Raises the PointerMoved event

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
MouseEventArgs e
Overrides

Events

| Improve this Doc View Source

Click

Occurs when a Button is clicked.

Declaration
public event RoutedEventHandler Click
Event Type
Type Description
RoutedEventHandler

Extension Methods