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 EnableControlState.

C#
Copy
public class ControlState : IEquatable<ControlState>
Inheritance
ControlState

Fields

View Source

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#
Copy
public static readonly ControlState All
Field Value
Type Description
ControlState
API Level: 9
View Source

Disabled

Disabled State.

Declaration
C#
Copy
public static readonly ControlState Disabled
Field Value
Type Description
ControlState
API Level: 9
View Source

DisabledFocused

DisabledFocused State.

Declaration
C#
Copy
public static readonly ControlState DisabledFocused
Field Value
Type Description
ControlState
View Source

DisabledSelected

DisabledSelected State.

Declaration
C#
Copy
public static readonly ControlState DisabledSelected
Field Value
Type Description
ControlState
View Source

Focused

Focused State.

Declaration
C#
Copy
public static readonly ControlState Focused
Field Value
Type Description
ControlState
API Level: 9
View Source

Normal

Normal State.

Declaration
C#
Copy
public static readonly ControlState Normal
Field Value
Type Description
ControlState
API Level: 9
View Source

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#
Copy
public static readonly ControlState Other
Field Value
Type Description
ControlState
API Level: 9
View Source

Pressed

Pressed State.

Declaration
C#
Copy
public static readonly ControlState Pressed
Field Value
Type Description
ControlState
API Level: 9
View Source

Selected

Selected State.

Declaration
C#
Copy
public static readonly ControlState Selected
Field Value
Type Description
ControlState
API Level: 9
View Source

SelectedFocused

SelectedFocused State.

Declaration
C#
Copy
public static readonly ControlState SelectedFocused
Field Value
Type Description
ControlState
View Source

SelectedPressed

SelectedPressed State.

Declaration
C#
Copy
public static readonly ControlState SelectedPressed
Field Value
Type Description
ControlState

Properties

View Source

IsCombined

Gets or sets a value indicating whether it has combined states.

Declaration
C#
Copy
public bool IsCombined { get; }
Property Value
Type Description
Boolean

Methods

View Source

Contains(ControlState)

Determines whether a state contains a specified state.

Declaration
C#
Copy
public 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.

API Level: 9
View Source

Create(String)

Create an instance of the ControlState with state name.

Declaration
C#
Copy
public static ControlState Create(string name)
Parameters
Type Name Description
String name

The state name.

Returns
Type Description
ControlState

The ControlState instance which has single state.

API Level: 9
View Source

Create(ControlState[])

Create an instance of the ControlState with combined states.

Declaration
C#
Copy
public static ControlState Create(params ControlState[] states)
Parameters
Type Name Description
ControlState[] states

The control state array.

Returns
Type Description
ControlState

The ControlState instance which has combined state.

View Source

Equals(Object)

Declaration
C#
Copy
public override bool Equals(object other)
Parameters
Type Name Description
Object other
Returns
Type Description
Boolean
API Level: 9
View Source

Equals(ControlState)

Declaration
C#
Copy
public bool Equals(ControlState other)
Parameters
Type Name Description
ControlState other
Returns
Type Description
Boolean
View Source

GetHashCode()

Declaration
C#
Copy
public override int GetHashCode()
Returns
Type Description
Int32
View Source

ToString()

Declaration
C#
Copy
public override string ToString()
Returns
Type Description
String

Operators

View Source

Addition(ControlState, ControlState)

The addition operator.

Declaration
C#
Copy
public 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
View Source

Equality(ControlState, ControlState)

Compares whether the two ControlStates are same or not.

Declaration
C#
Copy
public 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
View Source

Inequality(ControlState, ControlState)

Compares whether the two ControlStates are different or not.

Declaration
C#
Copy
public 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.

API Level: 9
View Source

Subtraction(ControlState, ControlState)

The substraction operator.

Declaration
C#
Copy
public 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 substraction.

Extension Methods