Class Button

Definition

Namespace:
Tizen.NUI.Components
Assembly:
Tizen.NUI.Components.dll

Button is one kind of common component, a button clearly describes what action will occur when the user selects it. Button may contain text or an icon.

public class Button : Control, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
Inheritance
object
BindableObject
Element
BaseHandle
Animatable
Container
View
ViewWrapper
CustomView
VisualView
Control
Button
Derived
SelectButton
Switch
Implements
IDynamicResourceHandler
INameScope
System.IDisposable
IResourcesProvider

Constructors

View Source

Button()

Creates a new instance of a Button.

Declaration
public Button()
View Source

Button(string)

Creates a new instance of a Button with style.

Declaration
public Button(string style)
Parameters
Type Name Description
string style

Create Button by special style defined in UX.
View Source

Button(ButtonStyle)

Creates a new instance of a Button with style.

Declaration
public Button(ButtonStyle buttonStyle)
Parameters
Type Name Description
ButtonStyle buttonStyle

Create Button by style customized by user.

Fields

View Source

FontFamilyProperty

FontFamilyProperty

Declaration
public static readonly BindableProperty FontFamilyProperty
Field Value
Type Description
BindableProperty
View Source

IconPaddingProperty

Declaration
public static readonly BindableProperty IconPaddingProperty
Field Value
Type Description
BindableProperty
View Source

IconRelativeOrientationProperty

Declaration
public static readonly BindableProperty IconRelativeOrientationProperty
Field Value
Type Description
BindableProperty
View Source

IconSizeProperty

IconSizeProperty

Declaration
public static readonly BindableProperty IconSizeProperty
Field Value
Type Description
BindableProperty
View Source

IconURLProperty

IconURLProperty

Declaration
public static readonly BindableProperty IconURLProperty
Field Value
Type Description
BindableProperty
View Source

IconURLSelectorProperty

IconURLSelectorProperty

Declaration
public static readonly BindableProperty IconURLSelectorProperty
Field Value
Type Description
BindableProperty
View Source

IsSelectableProperty

Declaration
public static readonly BindableProperty IsSelectableProperty
Field Value
Type Description
BindableProperty
View Source

IsSelectedProperty

Declaration
public static readonly BindableProperty IsSelectedProperty
Field Value
Type Description
BindableProperty
View Source

PointSizeProperty

PointSizeProperty

Declaration
public static readonly BindableProperty PointSizeProperty
Field Value
Type Description
BindableProperty
View Source

PointSizeSelectorProperty

PointSizeSelectorProperty

Declaration
public static readonly BindableProperty PointSizeSelectorProperty
Field Value
Type Description
BindableProperty
View Source

TextAlignmentProperty

TextAlignmentProperty

Declaration
public static readonly BindableProperty TextAlignmentProperty
Field Value
Type Description
BindableProperty
View Source

TextColorProperty

TextColorProperty

Declaration
public static readonly BindableProperty TextColorProperty
Field Value
Type Description
BindableProperty
View Source

TextColorSelectorProperty

TextColorSelectorProperty

Declaration
public static readonly BindableProperty TextColorSelectorProperty
Field Value
Type Description
BindableProperty
View Source

TextPaddingProperty

Declaration
public static readonly BindableProperty TextPaddingProperty
Field Value
Type Description
BindableProperty
View Source

TextProperty

TextProperty

Declaration
public static readonly BindableProperty TextProperty
Field Value
Type Description
BindableProperty
View Source

TextSelectorProperty

TextSelectorProperty

Declaration
public static readonly BindableProperty TextSelectorProperty
Field Value
Type Description
BindableProperty
View Source

TranslatableTextProperty

TranslatableTextProperty

Declaration
public static readonly BindableProperty TranslatableTextProperty
Field Value
Type Description
BindableProperty
View Source

TranslatableTextSelectorProperty

TranslatableTextSelectorProperty

Declaration
public static readonly BindableProperty TranslatableTextSelectorProperty
Field Value
Type Description
BindableProperty

Properties

View Source

Extension

The ButtonExtension instance that is injected by ButtonStyle.

Declaration
protected ButtonExtension Extension { get; set; }
Property Value
Type Description
ButtonExtension
View Source

FontFamily

Text font family in Button.

Declaration
public string FontFamily { get; set; }
Property Value
Type Description
string
View Source

Icon

Button's icon part.

Declaration
public ImageView Icon { get; }
Property Value
Type Description
ImageView
View Source

IconPadding

Icon padding in Button. It is shortcut of Icon.Padding.

Declaration
public Extents IconPadding { get; set; }
Property Value
Type Description
Extents
View Source

IconRelativeOrientation

Icon relative orientation in Button, work only when show icon and text.

Declaration
public Button.IconOrientation? IconRelativeOrientation { get; set; }
Property Value
Type Description
IconOrientation?
View Source

IconSize

Icon image's size in Button.

Declaration
public Size IconSize { get; set; }
Property Value
Type Description
Size
View Source

IconURL

Icon image's resource url in Button.

Declaration
public string IconURL { get; set; }
Property Value
Type Description
string
View Source

IconURLSelector

Icon image's resource url selector in Button. Getter returns copied selector value if exist, null otherwise.

Declaration
public StringSelector IconURLSelector { get; set; }
Property Value
Type Description
StringSelector
View Source

IsEnabled

Flag to decide enable or disable in Button.

Declaration
public bool IsEnabled { get; set; }
Property Value
Type Description
bool
View Source

IsSelectable

Flag to decide Button can be selected or not.

Declaration
public bool IsSelectable { get; set; }
Property Value
Type Description
bool
View Source

IsSelected

Flag to decide selected state in Button.

Declaration
public bool IsSelected { get; set; }
Property Value
Type Description
bool
View Source

ItemAlignment

The item (text or icon or both) alignment.

Declaration
public LinearLayout.Alignment ItemAlignment { get; set; }
Property Value
Type Description
LinearLayout.Alignment
View Source

ItemHorizontalAlignment

The item (text or icon or both) horizontal alignment.

Declaration
public HorizontalAlignment ItemHorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalAlignment
View Source

ItemSpacing

The space between icon and text. The value is applied when there exist icon and text both. The width value is used when the items are arranged horizontally. Otherwise, the height value is used.

Declaration
public Size2D ItemSpacing { get; set; }
Property Value
Type Description
Size2D
View Source

ItemVerticalAlignment

The item (text or icon or both) vertical alignment.

Declaration
public VerticalAlignment ItemVerticalAlignment { get; set; }
Property Value
Type Description
VerticalAlignment
View Source

OverlayImage

Button's overlay image part.

Declaration
public ImageView OverlayImage { get; }
Property Value
Type Description
ImageView
View Source

PointSize

Text point size in Button.

Declaration
public float PointSize { get; set; }
Property Value
Type Description
float
View Source

PointSizeSelector

Text font size selector in Button. Getter returns copied selector value if exist, null otherwise.

Declaration
public FloatSelector PointSizeSelector { get; set; }
Property Value
Type Description
FloatSelector
View Source

Style

The last applied style object copy.

Declaration
public ButtonStyle Style { get; }
Property Value
Type Description
ButtonStyle
Remarks

Modifying contents in style may cause unexpected behaviour.

View Source

Text

The text of Button.

Declaration
public string Text { get; set; }
Property Value
Type Description
string
View Source

TextAlignment

Text horizontal alignment in Button.

Declaration
public HorizontalAlignment TextAlignment { get; set; }
Property Value
Type Description
HorizontalAlignment
View Source

TextColor

Text color in Button.

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
Color
View Source

TextColorSelector

Text color selector in Button. Getter returns copied selector value if exist, null otherwise.

Declaration
public ColorSelector TextColorSelector { get; set; }
Property Value
Type Description
ColorSelector
View Source

TextLabel

Button's text part.

Declaration
public TextLabel TextLabel { get; }
Property Value
Type Description
TextLabel
View Source

TextPadding

Text padding in Button. It is shortcut of TextLabel.Padding.

Declaration
public Extents TextPadding { get; set; }
Property Value
Type Description
Extents
View Source

TextSelector

Text string selector in Button. Getter returns copied selector value if exist, null otherwise. Thrown when setting null value.

Declaration
public StringSelector TextSelector { get; set; }
Property Value
Type Description
StringSelector
View Source

TranslatableText

Translate text string in Button.

Declaration
public string TranslatableText { get; set; }
Property Value
Type Description
string
View Source

TranslatableTextSelector

Translatable text string selector in Button. Getter returns copied selector value if exist, null otherwise.

Declaration
public StringSelector TranslatableTextSelector { get; set; }
Property Value
Type Description
StringSelector

Methods

View Source

AccessibilityCalculateStates()

Calculates current states for the button

Declaration
protected override AccessibilityStates AccessibilityCalculateStates()
Returns
Type Description
AccessibilityStates
Overrides
View Source

AccessibilityGetName()

Gets accessibility name.

Declaration
protected override string AccessibilityGetName()
Returns
Type Description
string
Overrides
View Source

ApplyStyle(ViewStyle)

Apply style to button.

Declaration
public override void ApplyStyle(ViewStyle viewStyle)
Parameters
Type Name Description
ViewStyle viewStyle

The style to apply.
Overrides
View Source

CreateIcon()

Creates Button's icon part.

Declaration
protected virtual ImageView CreateIcon()
Returns
Type Description
ImageView
View Source

CreateOverlayImage()

Creates Button's overlay image part.

Declaration
protected virtual ImageView CreateOverlayImage()
Returns
Type Description
ImageView
View Source

CreateText()

Creates Button's text part.

Declaration
protected virtual TextLabel CreateText()
Returns
Type Description
TextLabel
View Source

CreateViewStyle()

Get Button style.

Declaration
protected override ViewStyle CreateViewStyle()
Returns
Type Description
ViewStyle

The default button style.
Overrides
View Source

Dispose(DisposeTypes)

Dispose Button and all children on it.

Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

Dispose type.
Overrides
View Source

HandleControlStateOnTouch(Touch)

The touch event handler for ControlState. Please change ControlState value by touch state if needed.

Declaration
protected override bool HandleControlStateOnTouch(Touch touch)
Parameters
Type Name Description
Touch touch
Returns
Type Description
bool
Overrides
View Source

LayoutItems()

Put sub items (e.g. buttonText, buttonIcon) to the right place.

Declaration
protected virtual void LayoutItems()
View Source

OnClicked(ClickedEventArgs)

Called when the Button is Clicked by a user

Declaration
protected virtual void OnClicked(ClickedEventArgs eventArgs)
Parameters
Type Name Description
ClickedEventArgs eventArgs

The click information.
View Source

OnControlStateChanged(ControlStateChangedEventArgs)

Called after the View's ControlStates changed.

Declaration
protected override void OnControlStateChanged(View.ControlStateChangedEventArgs controlStateChangedInfo)
Parameters
Type Name Description
View.ControlStateChangedEventArgs controlStateChangedInfo

The information including state changed variables.
Overrides
View Source

OnEnabled(bool)

Internal callback of enabled property changes. Inherited view can override this method to implements enabled property changes.

Declaration
protected override void OnEnabled(bool enabled)
Parameters
Type Name Description
bool enabled
Overrides
View Source

OnFocusGained()

Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when the focus is gained.

Declaration
public override void OnFocusGained()
Overrides
View Source

OnFocusLost()

Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when the focus is lost.

Declaration
public override void OnFocusLost()
Overrides
View Source

OnInitialize()

Initializes AT-SPI object.

Declaration
public override void OnInitialize()
Overrides
View Source

OnKey(Key)

Called after a key event is received by the view that has had its focus set.

Declaration
public override bool OnKey(Key key)
Parameters
Type Name Description
Key key

The key event.
Returns
Type Description
bool

True if the key event should be consumed.
Overrides
View Source

OnRelayout(Vector2, RelayoutContainer)

Called after the size negotiation has been finished for this control.
The control is expected to assign this given size to itself or its children.
Should be overridden by derived classes if they need to layout views differently after certain operations like add or remove views, resize, or after changing specific properties.
As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).

Declaration
public override void OnRelayout(Vector2 size, RelayoutContainer container)
Parameters
Type Name Description
Vector2 size

The allocated size.
RelayoutContainer container

The control should add views to this container that it is not able to allocate a size for.
Overrides
View Source

OnTouch(Touch)

Called after a touch event is received by the owning view.
CustomViewBehaviour.REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomView(ViewWrapperImpl.CustomViewBehaviour behaviour).

Declaration
public override bool OnTouch(Touch touch)
Parameters
Type Name Description
Touch touch

The touch event.
Returns
Type Description
bool

True if the event should be consumed.
Overrides
View Source

OnUpdate()

Declaration
protected override void OnUpdate()
Overrides
View Source

UpdateState()

Update Button State.

Declaration
protected void UpdateState()

Events

View Source

Clicked

An event for the button clicked signal which can be used to subscribe or unsubscribe the event handler provided by the user.

Declaration
public event EventHandler<ClickedEventArgs> Clicked
Event Type
Type Description
EventHandler<><ClickedEventArgs>
View Source

ClickEvent

An event for the button clicked signal which can be used to subscribe or unsubscribe the event handler provided by the user.

Declaration
public event EventHandler<Button.ClickEventArgs> ClickEvent
Event Type
Type Description
EventHandler<><ClickEventArgs>
View Source

StateChangedEvent

An event for the button state changed signal which can be used to subscribe or unsubscribe the event handler provided by the user.

Declaration
public event EventHandler<Button.StateChangedEventArgs> StateChangedEvent
Event Type
Type Description
EventHandler<><StateChangedEventArgs>

Implements

System.IDisposable

Extension Methods