Class ControlState
Definition
- Namespace:
- Tizen.NUI.BaseComponents
- Assembly:
- Tizen.NUI.dll
- API Level:
- 9
Class for describing the states of control. If a non-control view class would want to get the control state, please refer Tizen.NUI.BaseComponents.View.EnableControlState.
C#Copypublic class ControlState : IEquatable<ControlState>
- Inheritance
-
System.ObjectControlState
- Implements
-
System.IEquatable<ControlState>
Fields
All
The All state is used in a selector class. It represents all states, so if this state is defined in a selector, the other states are ignored.
Declaration
C#Copypublic static readonly ControlState All
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Declaration
C#Copypublic static readonly ControlState Disabled
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Declaration
C#Copypublic static readonly ControlState Focused
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Declaration
C#Copypublic static readonly ControlState Normal
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Other
This is used in a selector class. It represents all other states except for states that are already defined in a selector.
Declaration
C#Copypublic static readonly ControlState Other
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Declaration
C#Copypublic static readonly ControlState Pressed
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Declaration
C#Copypublic static readonly ControlState Selected
Field Value
Type | Description |
---|---|
ControlState |
API Level: 9
Methods
Declaration
C#Copypublic bool Contains(ControlState state)
Parameters
Type | Name | Description |
---|---|---|
ControlState | state | The state to search for |
Returns
Type | Description |
---|---|
Boolean | true if the state contain a specified state, otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the given state is null. |
API Level: 9
Declaration
C#Copypublic static ControlState Create(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The state name. |
Returns
Type | Description |
---|---|
ControlState | The ControlState instance which has single state. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the given name is null. |
System.ArgumentException | Thrown when the given name is invalid. |
API Level: 9
Declaration
C#Copypublic override bool Equals(object other)
Parameters
Type | Name | Description |
---|---|---|
System.Object | other |
Returns
Type | Description |
---|---|
Boolean |
Overrides
API Level: 9
Operators
Declaration
C#Copypublic static ControlState operator +(ControlState lhs, ControlState rhs)
Parameters
Type | Name | Description |
---|---|---|
ControlState | lhs | A ControlState on the left hand side. |
ControlState | rhs | A ControlState on the right hand side. |
Returns
Type | Description |
---|---|
ControlState | The ControlState containing the result of the addition. |
API Level: 9
Equality(ControlState, ControlState)
Compares whether the two ControlStates are same or not.
Declaration
C#Copypublic static bool operator ==(ControlState lhs, ControlState rhs)
Parameters
Type | Name | Description |
---|---|---|
ControlState | lhs | A ControlState on the left hand side. |
ControlState | rhs | A ControlState on the right hand side. |
Returns
Type | Description |
---|---|
Boolean | true if the ControlStates are equal; otherwise, false. |
API Level: 9
Inequality(ControlState, ControlState)
Compares whether the two ControlStates are different or not.
Declaration
C#Copypublic static bool operator !=(ControlState lhs, ControlState rhs)
Parameters
Type | Name | Description |
---|---|---|
ControlState | lhs | A ControlState on the left hand side. |
ControlState | rhs | A ControlState on the right hand side. |
Returns
Type | Description |
---|---|
Boolean | true if the ControlStates are not equal; otherwise, false. |