ComponentStatus

References
Provides information about selection, highlighting, visibility, editability and integrity states of a component.

This structure is immutable.

Properties

AllSet

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

Clear

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

Damaged

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

Hidden

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

Highlighted

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

IsClear

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

IsDamaged

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

IsHidden

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

IsHighlighted

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

IsLocked

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

IsSelected

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

IsSelectedPersistent

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

Locked

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

Selected

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

SelectedPersistent

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

Methods

Equals

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

Equals

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

GetHashCode

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

HasAllEqualStates

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

HasNoEqualStates

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

HasSomeEqualStates

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

ToString

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

WithStates

#Since v6.0
Activates any information flag described in any of the two input component statuses and returns a new ComponentStatus with those flags checked.
[ConstOperation] public ComponentStatus WithStates(
additionalStatus
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.