Definition
- Namespace:
- Tizen.NUI.Components
- Assembly:
- Tizen.NUI.Components.dll
Switch is a kind of Button component that uses icon part as a toggle shape.
The icon part consists of track and thumb.
public class Switch : Button, INotifyPropertyChanged, IDisposable
- Inheritance
-
object
Tizen.NUI.Binding.Element
Tizen.NUI.Components.Control
Switch
- Implements
-
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Constructors
View Source
Switch()
Creates a new instance of a Switch.
Declaration
View Source
Switch(string)
Creates a new instance of a Switch with style.
Declaration
public Switch(string style)
Parameters
| Type |
Name |
Description |
| string |
style |
Create Switch by special style defined in UX.
|
View Source
Switch(SwitchStyle)
Creates a new instance of a Switch with style.
Declaration
public Switch(SwitchStyle switchStyle)
Parameters
| Type |
Name |
Description |
| SwitchStyle |
switchStyle |
Create Switch by style customized by user.
|
Properties
Declaration
public SwitchStyle Style { get; }
Property Value
View Source
SwitchBackgroundImageURLSelector
Switch's track part image url selector.
Declaration
public StringSelector SwitchBackgroundImageURLSelector { get; set; }
Property Value
| Type |
Description |
| Tizen.NUI.Components.StringSelector |
|
View Source
SwitchHandlerImageSize
Handler image's size in Switch.
Declaration
public Size SwitchHandlerImageSize { get; set; }
Property Value
View Source
SwitchHandlerImageURL
Handler image's resource url in Switch.
Declaration
public string SwitchHandlerImageURL { get; set; }
Property Value
View Source
SwitchHandlerImageURLSelector
Handler image's resource url selector in Switch.
Getter returns copied selector value if exist, null otherwise.
Declaration
public StringSelector SwitchHandlerImageURLSelector { get; set; }
Property Value
| Type |
Description |
| Tizen.NUI.Components.StringSelector |
|
Declaration
public ImageView Thumb { get; }
Property Value
Declaration
public ImageView Track { get; }
Property Value
Methods
Declaration
protected override ViewStyle CreateViewStyle()
Returns
| Type |
Description |
| ViewStyle |
The default switch style.
|
Overrides
View Source
Dispose(DisposeTypes)
Dispose Switch and all children on it.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
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
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 Source
SelectedChanged
An event for the item selected signal which can be used to subscribe or unsubscribe the event handler provided by the user.
Declaration
public event EventHandler<SelectedChangedEventArgs> SelectedChanged
Event Type
View Source
SelectedEvent
An event for the item selected 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 SelectedChanged event instead.")]
public event EventHandler<Switch.SelectEventArgs> SelectedEvent
Event Type
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable