Class ControlState

    Definition

    Namespace:
    Tizen.NUI.BaseComponents
    Assembly:
    Tizen.NUI.dll

    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.

    public class ControlState : IEquatable<ControlState>
    Inheritance
    object
    ControlState
    Implements
    System.IEquatable<T><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
    public static readonly ControlState All
    Field Value
    Type Description
    ControlState
    View Source

    Disabled

    Disabled State.

    Declaration
    public static readonly ControlState Disabled
    Field Value
    Type Description
    ControlState
    View Source

    Focused

    Focused State.

    Declaration
    public static readonly ControlState Focused
    Field Value
    Type Description
    ControlState
    View Source

    Normal

    Normal State.

    Declaration
    public static readonly ControlState Normal
    Field Value
    Type Description
    ControlState
    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
    public static readonly ControlState Other
    Field Value
    Type Description
    ControlState
    View Source

    Pressed

    Pressed State.

    Declaration
    public static readonly ControlState Pressed
    Field Value
    Type Description
    ControlState
    View Source

    Selected

    Selected State.

    Declaration
    public static readonly ControlState Selected
    Field Value
    Type Description
    ControlState

    Methods

    View Source

    Contains(ControlState)

    Determines whether a state contains a specified state.

    Declaration
    public bool Contains(ControlState state)
    Parameters
    Type Name Description
    ControlState state

    The state to search for

    Returns
    Type Description
    bool

    true if the state contain a specified state, otherwise, false.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when the given state is null.

    View Source

    Create(string)

    Create an instance of the ControlState with state name.

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

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when the given name is null.

    System.ArgumentException

    Thrown when the given name is invalid.

    View Source

    Equals(object)

    Declaration
    public override bool Equals(object other)
    Parameters
    Type Name Description
    object other
    Returns
    Type Description
    bool
    Overrides
    object.Equals(object)

    Operators

    View Source

    operator +(ControlState, ControlState)

    The addition operator.

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

    View Source

    operator ==(ControlState, ControlState)

    Compares whether the two ControlStates are same or not.

    Declaration
    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
    bool

    true if the ControlStates are equal; otherwise, false.

    View Source

    operator !=(ControlState, ControlState)

    Compares whether the two ControlStates are different or not.

    Declaration
    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
    bool

    true if the ControlStates are not equal; otherwise, false.

    Implements

    System.IEquatable<T>
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX