ComponentStatus
ReferencesProvides information about selection, highlighting, visibility, editability and integrity states of a component.
This structure is immutable.
Properties
This is the default value and equal to undefined.
The highlight selection flag is checked.
True if every setting is 0 or false.
Returns: True if the component status is undefined or clear.
Returns false if component is not damaged. True otherwise.
Returns: The component status for damaged.
Returns true if highlighted. False otherwise.
Returns: The component status for highlighted.
Returns true if locked. False otherwise.
Returns: The component status for locked.
Returns true if selected or selected persistent. False otherwise.
Returns: The component status for selected.
Returns true if selected persistent. False otherwise.
Returns: The component status for selected.
The persistent selection flag is checked.
Methods
Determines if another ComponentStatus and this are equal.
Returns: true if equal in value. false otherwise
Equals
#Determines if an object and this are equal.
Returns: true if equal in value. false otherwise
Overrides: ValueType.Equals
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
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.
Returns: True if at all tested states in "this" and comparand are identical.
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.
Returns: True if at all tested states in "this" and comparand are identical.
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.
Returns: True if at least one tested state in "this" and comparand are identical.
ToString
#Provides a string representation of this ComponentStatus.
Returns: The representation in English.
Overrides: ValueType.ToString
Activates any information flag described in any of the two input component statuses and returns a new ComponentStatus with those flags checked.
Operators
| Operation | Result | Description | ||
|---|---|---|---|---|
| ComponentStatus | + | ComponentStatus | ComponentStatus | Sets flags from both component states and returns a new ComponentStatus. |
| ComponentStatus | == | ComponentStatus | bool | Determines if two ComponentStatus objects are equal. |
| ComponentStatus | != | ComponentStatus | bool | Determines if two ComponentStatus objects differ. |