ComponentStatus

References
public struct ComponentStatus : IEquatable<ComponentStatus>
Provides information about selection, highlighting, visibility, editability and integrity states of a component.

This structure is immutable.

Properties

AllSet

#Since v6.0
public static ComponentStatus AllSet { get; }
All flags are checked.

Clear

#Since v6.0
public static ComponentStatus Clear { get; }
This is the default value and equal to undefined.

Damaged

#Since v6.0
public static ComponentStatus Damaged { get; }
The damaged flag is checked.

Hidden

#Since v6.0
public static ComponentStatus Hidden { get; }
The hidden flag is checked.

Highlighted

#Since v6.0
public static ComponentStatus Highlighted { get; }
The highlight selection flag is checked.

IsClear

#Since v6.0
public bool IsClear { get; }
True if every setting is 0 or false.
Returns: True if the component status is undefined or clear.

IsDamaged

#Since v6.0
public bool IsDamaged { get; }
Returns false if component is not damaged. True otherwise.
Returns: The component status for damaged.

IsHidden

#Since v6.0
public bool IsHidden { get; }
Returns true if hidden. False otherwise.
Returns: The component status for hidden.

IsHighlighted

#Since v6.0
public bool IsHighlighted { get; }
Returns true if highlighted. False otherwise.
Returns: The component status for highlighted.

IsLocked

#Since v6.0
public bool IsLocked { get; }
Returns true if locked. False otherwise.
Returns: The component status for locked.

IsSelected

#Since v6.0
public bool IsSelected { get; }
Returns true if selected or selected persistent. False otherwise.
Returns: The component status for selected.

IsSelectedPersistent

#Since v6.0
public bool IsSelectedPersistent { get; }
Returns true if selected persistent. False otherwise.
Returns: The component status for selected.

Locked

#Since v6.0
public static ComponentStatus Locked { get; }
The locked flag is checked.

Selected

#Since v6.0
public static ComponentStatus Selected { get; }
The selection flag is checked.

SelectedPersistent

#Since v6.0
public static ComponentStatus SelectedPersistent { get; }
The persistent selection flag is checked.

Methods

Equals

#Since v6.0
public bool Equals(ComponentStatus other)
Determines if another ComponentStatus and this are equal.
Parameters:
other (ComponentStatus)A ComponentStatus.
Returns: true if equal in value. false otherwise

Equals

#
[ConstOperation] public override bool Equals(object obj)
Determines if an object and this are equal.
Parameters:
obj (object)An object.
Returns: true if equal in value. false otherwise
Overrides: ValueType.Equals

GetHashCode

#
[ConstOperation] public override int GetHashCode()
Serves as a special hash function. The inner value is used for the purpose.
Returns: An integer deriving from a bit mask.
Overrides: ValueType.GetHashCode

HasAllEqualStates

#Since v6.0
[ConstOperation] public bool HasAllEqualStates(ComponentStatus statesFilter, ComponentStatus comparand)
For the purposes of this test, Selected and SelectedPersistent are considered equal.
Parameters:
statesFilter (ComponentStatus)If no states are specified, then false is returned.
comparand (ComponentStatus)If a state is set in states_filter, the corresponding state in "this" and comparand will be tested.
Returns: True if at all tested states in "this" and comparand are identical.

HasNoEqualStates

#Since v6.0
[ConstOperation] public bool HasNoEqualStates(ComponentStatus statesFilter, ComponentStatus comparand)
For the purposes of this test, Selected and SelectedPersistent are considered equal.
Parameters:
statesFilter (ComponentStatus)If no states are specified, then false is returned.
comparand (ComponentStatus)If a state is set in states_filter, the corresponding state in "this" and comparand will be tested.
Returns: True if at all tested states in "this" and comparand are identical.

HasSomeEqualStates

#Since v6.0
[ConstOperation] public bool HasSomeEqualStates(ComponentStatus statesFilter, ComponentStatus comparand)
For the purposes of this test, Selected and SelectedPersistent are considered equal.
Parameters:
statesFilter (ComponentStatus)If no states are specified, then false is returned.
comparand (ComponentStatus)If a state is set in states_filter, the corresponding state in "this" and comparand will be tested.
Returns: True if at least one tested state in "this" and comparand are identical.

ToString

#
[ConstOperation] public override string ToString()
Provides a string representation of this ComponentStatus.
Returns: The representation in English.
Overrides: ValueType.ToString

WithStates

#Since v6.0
[ConstOperation] public ComponentStatus WithStates(ComponentStatus additionalStatus)
Activates any information flag described in any of the two input component statuses and returns a new ComponentStatus with those flags checked.
Parameters:
additionalStatus (ComponentStatus)To be used for adding status values.

Operators

OperationResultDescription
ComponentStatus+ComponentStatusComponentStatusSets flags from both component states and returns a new ComponentStatus.
ComponentStatus==ComponentStatusboolDetermines if two ComponentStatus objects are equal.
ComponentStatus!=ComponentStatusboolDetermines if two ComponentStatus objects differ.