Button

Represents a button control that reacts to touch events.

Properties

PropertyTypeDescription
BackgroundColorThe background color of the control.
BorderColorThe color of the control's border.
BorderThicknessFloatThe width of the control's border.
CornerRadiusIntegerThe radius for the corners of the control's border.
ForegroundColorThe color of the control's content.
IconIconThe icon for the control.
IconPositionEnumThe position of the icon relative to the text. Possible values are Left, Right, & Top.
IconSizeFloatThe size of the icon in dp pixels.
IconSpacingFloatThe spacing between the icon and text.
ShowAsMonochromeBooleanA value that indicates whether the Foreground color is applied to the icon.
FontSizeFloatThe size of the text in dp pixels.
FontStyleEnumThe style in which the text is rendered. Possible values are Normal & Italic.
FontWeightEnumThe thickness of the specified font. Possible values are Thin, Light, Normal, Medium, Bold, Black
TextStringA string that specifies the text contents of the button.
TextDecorationsEnumA value that indicates what decorations are applied to the text. Possible values are None, Strikethrough, & Underline.
ButtonTypeEnumThe type of button. Possible values are Normal, Repeat, & Toggle.
IsCheckedBooleanA value that indicates whether the button is checked. This applies only when ButtonType is set to Toggle
IsPressedBooleanA value that indicates whether the button is currently in a pressed state.
RepeatIntervalIntegerThe time, in milliseconds, between repetitions of the click action, as soon as repeating starts. This applies only when ButtonType is set to Repeat.
HeightFloatThe suggested height of the control in dp pixels.
HorizontalAlignmentEnumThe horizontal alignment characteristics that are applied to the control when it is composed in a parent layout panel, such as a Grid.
HorizontalContentAlignmentEnumThe horizontal alignment of the control's content.
MarginThicknessThe outer margin that is applied to the control when it is composed in a parent layout panel, such as a Grid.
PaddingThicknessThe amount of space between the content of the control and its border.
RotationIntegerThe rotation about the Z-axis in degrees.
VerticalAlignmentEnumThe vertical alignment characteristics that are applied to the control when it is composed in a parent layout panel, such as a Grid.
VerticalContentAlignmentEnumThe vertical alignment of the control's content
WidthFloatThe suggested width of the control in dp pixels.
IsEnabledBooleanA value that indicates whether the user can interact with the control.
IsHitTestVisibleBooleanA value that indicates whether the contained area of the control can return true values for hit testing.
IsVisibleBooleanA value that indicates whether the control should be visible.
OpacityFloatA value between 0 and 1.0 that declares the opacity factor, with 1.0 meaning full opacity and 0 meaning transparent.

Events

EventDescription
LoadedOccurs when the element is laid out, rendered, and ready for interaction.
UnloadedOccurs when the element is no longer rendered on the screen.
ClickedOccurs when the button control is clicked.
PressedOccurs when the button control is pressed.
ReleasedOccurs when the button control is released.
CanceledOccurs when the button control click is canceled.
CheckedOccurs when the button is checked. This applies only when ButtonType is set to Toggle.
UncheckedOccurs when the button is unchecked. This applies only when ButtonType is set to Toggle.