Class Switch
Definition
- Namespace:
- Tizen.NUI.Components
- Assembly:
- Tizen.NUI.Components.dll
Switch is one kind of common component, it can be used as selector. User can handle Navigation by adding/inserting/deleting NavigationItem.
public class Switch : Button, INotifyPropertyChanged, IDisposable
- Inheritance
-
objectTizen.NUI.Binding.BindableObjectTizen.NUI.Binding.ElementTizen.NUI.Components.ControlSwitch
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
View SourceSwitch()
Creates a new instance of a Switch.
Declaration
public Switch()
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. |
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
View SourceStyle
Return a copied Style instance of Switch
Declaration
public SwitchStyle Style { get; }
Property Value
| Type | Description |
|---|---|
| SwitchStyle |
Remarks
It returns copied Style instance and changing it does not effect to the Switch. Style setting is possible by using constructor or the function of ApplyStyle(ViewStyle viewStyle)
SwitchBackgroundImageURLSelector
Background image's resource url selector in Switch.
Declaration
public StringSelector SwitchBackgroundImageURLSelector { get; set; }
Property Value
| Type | Description |
|---|---|
| Tizen.NUI.Components.StringSelector |
SwitchHandlerImageSize
Handler image's size in Switch.
Declaration
public Size SwitchHandlerImageSize { get; set; }
Property Value
| Type | Description |
|---|---|
| Size |
SwitchHandlerImageURL
Handler image's resource url in Switch.
Declaration
public string SwitchHandlerImageURL { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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 |
Thumb
Switch's thumb part.
Declaration
public ImageView Thumb { get; }
Property Value
| Type | Description |
|---|---|
| ImageView |
Track
Switch's track part.
Declaration
public ImageView Track { get; }
Property Value
| Type | Description |
|---|---|
| ImageView |
Methods
View SourceCreateViewStyle()
Get Switch style.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
| Type | Description |
|---|---|
| Tizen.NUI.BaseComponents.ViewStyle | The default switch style. |
Overrides
View SourceDispose(DisposeTypes)
Dispose Switch and all children on it.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
| Type | Name | Description |
|---|---|---|
| DisposeTypes | type | Dispose type. |
Overrides
View SourceOnKey(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 SourceOnTouch(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 SourceSelectedChanged
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
| Type | Description |
|---|---|
| System.EventHandler<TEventArgs><SelectedChangedEventArgs> |
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
| Type | Description |
|---|---|
| System.EventHandler<TEventArgs><Switch.SelectEventArgs> |