Search
ButtonComponent Members
Constructors Properties Methods Events
 


Represents a button-like component, which can respond to user clicks.

The following tables list the members exposed by the ButtonComponent type.

 Public Constructors

  Name Description

ButtonComponent

Initializes a new instance of the ButtonComponent class.

 Public Properties

  Name Description

AutoProperty

Gets or sets a value indicating whether the component is defined as a property on the client side. (Inherited from ComponentBase.)

Bounds

Gets or sets the calculated bounds of this component relative to its parent. (Inherited from ComponentBase.)

Brush

Gets or sets the background brush of the button when it is in normal state.

BrushHovered

Gets or sets the background brush of the button when it is in hovered state.

BrushPressed

Gets or sets the background brush of the button when it is in pressed state.

ChildCount

ComponentBase.ChildCount override. (Inherited from ContentComponent.)

Content

Gets or sets the content of this component. (Inherited from ContentComponent.)

Focusable

Gets or sets a value indicating whether the component can receive the input focus. (Inherited from ComponentBase.)

GridColumn

Gets or sets the index of the grid column this component will be associated with when added to a GridPanel. (Inherited from ComponentBase.)

GridRow

Gets or sets the index of the grid row this component will be associated with when added to a GridPanel. (Inherited from ComponentBase.)

Height

Gets or sets the explicit height of this component or double.NaN to auto-size the component. (Inherited from ComponentBase.)

HorizontalAlignment

Gets or sets the horizontal alignment of this component relative to its parent. (Inherited from ComponentBase.)

ImageList

Gets or sets a list with images. Each image in the list represents the appearance of the button in one of its states: 0 - normal, 1 - pressed, 2 - disabled, 3 - hovered.

IsEnabled

Gets or sets a value indicating whether the component is enabled. (Inherited from ComponentBase.)

IsFocused

Gets or sets a value indicating whether this component currently holds the input focus. (Inherited from ComponentBase.)

IsHitTestVisible

Gets or sets a value indicating whether this component and all its children are subject to hit-testing operations. (Inherited from ComponentBase.)

IsInteractive

Gets or sets a value indicating whether this component can be interacted with. (Inherited from ComponentBase.)

Name

Gets or sets the name of the component. (Inherited from ComponentBase.)

Padding

Gets or sets the padding around this component's content. (Inherited from ContentComponent.)

Parent

Gets the parent component, if the current component is hosted. (Inherited from ComponentBase.)

Pen

Gets or sets the border pen of the button when it is in normal state.

PenHovered

Gets or sets the border pen of the button when it is in hovered state.

PenPressed

Gets or sets the border pen of the button when it is in pressed state.

Type

Gets or sets the type of the button.

VerticalAlignment

Gets or sets the vertical alignment of this component relative to its parent. (Inherited from ComponentBase.)

Visible

Gets or sets a value indicating whether the component is visible. (Inherited from ComponentBase.)

Width

Gets or sets the explicit width of this component or double.NaN to auto-size the component. (Inherited from ComponentBase.)

 Protected Properties

  Name Description

ParentHost

Gets the host containing this component, if any. (Inherited from ComponentBase.)

State

Gets the current state of the button.

 Public Methods

  Name Description

ArrangeComponents

ComponentBase.ArrangeComponents override. (Inherited from ContentComponent.)

Contains

Checks if the specified component is contained in the hierarchy defined by the current component. (Inherited from ComponentBase.)

Draw

ContentComponent.Draw override.

Find

Returns the component with the specified name within the hierarchy defined by the current component. (Inherited from ComponentBase.)

GetCursor

ComponentBase.GetCursor override.

GetDesiredSize

ContentComponent.GetDesiredSize override.

Invalidate

Invalidates the visual appearance of the component. (Inherited from ComponentBase.)

InvalidateLayout

Invalidates the layout of this component and all its children. (Inherited from ComponentBase.)

OnKeyDown

ComponentBase.OnKeyDown override.

OnKeyPress

Called when a character key is pressed when this component has the input focus. (Inherited from ComponentBase.)

OnKeyUp

Called when a key is released when this component has the input focus. (Inherited from ComponentBase.)

OnMouseDown

ComponentBase.OnMouseDown override.

OnMouseMove

ComponentBase.OnMouseMove override.

OnMouseUp

ComponentBase.OnMouseDown override.

ToDocument

Converts a point from local to document coordinates. (Inherited from ComponentBase.)

ToLocal

Converts a point from document to local coordinates. (Inherited from ComponentBase.)

ToParent

Converts a point from local coordinates to the specified parent's coordinates. (Inherited from ComponentBase.)

 Protected Methods

  Name Description

GetImage

Gets the image from the button's image list corresponding to the current state of the button.

GetThickness

Gets the space around the component's content. This space includes padding by default but can be subsequently adjusted as necessary by the deriving classes. (Inherited from ContentComponent.)

LoadFromJson

ContentComponent.LoadFromJson override.

LoadFromXml

ContentComponent.LoadFromXml override.

OnAddedToParent

Invoked when the component is added to a parent component. (Inherited from ComponentBase.)

OnClicked

Raises the Clicked event.

OnCustomDraw

Raises the CustomDraw event.

OnGotFocus

Invokes when the component gains the input focus. (Inherited from ComponentBase.)

OnGotFocus

Raises the GotFocus event. (Inherited from ComponentBase.)

OnLostFocus

Raises the LostFocus event. (Inherited from ComponentBase.)

OnLostFocus

Invokes when the component loses the input focus. (Inherited from ComponentBase.)

OnMouseMove

Raises the MouseMove event. (Inherited from ComponentBase.)

OnRemovedFromParent

Invoked when the component is removed from a parent component. (Inherited from ComponentBase.)

OnRepeatEnded

Raises the RepeatEnded event.

OnUnitChanged

Invoked when the measure unit of the document containing the component has changed. (Inherited from ComponentBase.)

OnValidated

Raises the Validated event. (Inherited from ComponentBase.)

OnValidating

Raises the Validating event. (Inherited from ComponentBase.)

OnZoomChanged

Invoked when the zoom factor of the document containing the component has changed. (Inherited from ComponentBase.)

SaveToJson

ContentComponent.SaveToJson override.

SaveToXml

ContentComponent.SaveToXml override.

SerializeSubcomponents

Invoked to query whether the underlying component structure should be automatically serialized or serialized by the user. (Inherited from ComponentBase.)

 Public Events

  Name Description

Clicked

Raised when the button is clicked.

CustomDraw

Raised when the button is drawn to allow for custom drawing.

GotFocus

Raised when the component receives the input focus. (Inherited from ComponentBase.)

LostFocus

Raised when the component loses the input focus. (Inherited from ComponentBase.)

MouseMove

Raised when the mouse moves over the component. (Inherited from ComponentBase.)

RepeatEnded

Raised when a repeat button has been released.

Validated

Raised after the component has lost input focus. (Inherited from ComponentBase.)

Validating

Raised when the component is about to lose input focus in order to validate it. (Inherited from ComponentBase.)

 See Also