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, INotifyPropertyChanged, IDisposable
- Inheritance
-
objectTizen.NUI.Binding.ElementTizen.NUI.Components.ControlButton
- Derived
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
View SourceButton()
Creates a new instance of a Button.
Declaration
public Button()
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. |
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. |
Properties
View SourceFontFamily
Text font family in Button.
Declaration
public string FontFamily { get; set; }
Property Value
Type | Description |
---|---|
string |
Icon
Button's icon part.
Declaration
public ImageView Icon { get; }
Property Value
Type | Description |
---|---|
ImageView |
IconPadding
Icon padding in Button. It is shortcut of Icon.Padding.
Declaration
public Extents IconPadding { get; set; }
Property Value
Type | Description |
---|---|
Extents |
IconRelativeOrientation
Icon relative orientation in Button, work only when show icon and text.
Declaration
public Button.IconOrientation? IconRelativeOrientation { get; set; }
Property Value
Type | Description |
---|---|
Button.IconOrientation? |
IconURL
Icon image's resource url in Button.
Declaration
public string IconURL { get; set; }
Property Value
Type | Description |
---|---|
string |
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 |
---|---|
Tizen.NUI.Components.StringSelector |
Exceptions
Type | Condition |
---|---|
System.NullReferenceException | Thrown when setting null value. |
IsEnabled
Flag to decide enable or disable in Button.
Declaration
public bool IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsSelectable
Flag to decide Button can be selected or not.
Declaration
public bool IsSelectable { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsSelected
Flag to decide selected state in Button.
Declaration
public bool IsSelected { get; set; }
Property Value
Type | Description |
---|---|
bool |
ItemAlignment
The item (text or icon or both) alignment.
Declaration
public LinearLayout.Alignment ItemAlignment { get; set; }
Property Value
Type | Description |
---|---|
LinearLayout.Alignment |
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 |
OverlayImage
Button's overlay image part.
Declaration
public ImageView OverlayImage { get; }
Property Value
Type | Description |
---|---|
ImageView |
PointSize
Text point size in Button.
Declaration
public float PointSize { get; set; }
Property Value
Type | Description |
---|---|
float |
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 |
---|---|
Tizen.NUI.Components.FloatSelector |
Exceptions
Type | Condition |
---|---|
System.NullReferenceException | Thrown when setting null value. |
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.
Text
The text of Button.
Declaration
public string Text { get; set; }
Property Value
Type | Description |
---|---|
string |
TextAlignment
Text horizontal alignment in Button.
Declaration
public HorizontalAlignment TextAlignment { get; set; }
Property Value
Type | Description |
---|---|
HorizontalAlignment |
TextColor
Text color in Button.
Declaration
public Color TextColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
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 |
---|---|
Tizen.NUI.Components.ColorSelector |
Exceptions
Type | Condition |
---|---|
System.NullReferenceException | Thrown when setting null value. |
TextLabel
Button's text part.
Declaration
public TextLabel TextLabel { get; }
Property Value
Type | Description |
---|---|
TextLabel |
TextPadding
Text padding in Button. It is shortcut of TextLabel.Padding.
Declaration
public Extents TextPadding { get; set; }
Property Value
Type | Description |
---|---|
Extents |
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 |
---|---|
Tizen.NUI.Components.StringSelector |
TranslatableText
Translate text string in Button.
Declaration
public string TranslatableText { get; set; }
Property Value
Type | Description |
---|---|
string |
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 |
---|---|
Tizen.NUI.Components.StringSelector |
Exceptions
Type | Condition |
---|---|
System.NullReferenceException | Thrown when setting null value. |
Methods
View SourceApplyStyle(ViewStyle)
Apply style to button.
Declaration
public override void ApplyStyle(ViewStyle viewStyle)
Parameters
Type | Name | Description |
---|---|---|
ViewStyle | viewStyle | The style to apply. |
Overrides
View SourceCreateViewStyle()
Get Button style.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
Type | Description |
---|---|
ViewStyle | The default button style. |
Overrides
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
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
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
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
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
[Obsolete("Deprecated in API8; Will be removed in API10. Please use OnClicked instead.")]
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
Events
View SourceClicked
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 |
---|---|
System.EventHandler<TEventArgs><ClickedEventArgs> |
ClickEvent
An event for the button clicked signal which can be used to subscribe or unsubscribe the event handler provided by the user.
Declaration
[Obsolete("Deprecated in API8; Will be removed in API10. Please use Clicked event instead.")]
public event EventHandler<Button.ClickEventArgs> ClickEvent
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><Button.ClickEventArgs> |
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
[Obsolete("Deprecated in API8; Will be removed in API10. Please use View.ControlStateChangedEvent")]
public event EventHandler<Button.StateChangedEventArgs> StateChangedEvent
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><Button.StateChangedEventArgs> |