Struct ElementId
Represents an element identifier.
Implements
Inherited Members
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 6, 0, 0)]
public struct ElementId : IEquatable<ElementId>Remarks
This structure is available since v7.6.
Constructors
ElementId(DocumentId, Int32)
Initializes a new instance of the ElementId structure.
Declaration
public ElementId(DocumentId inDocumentId, int inId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Document of the element. |
| Int32 | inId | Identifier of the element within its document, or 0 if empty. |
Fields
Empty
Empty identifier.
Declaration
public static readonly ElementId EmptyField Value
| Type | Description |
|---|---|
| ElementId |
Properties
DocumentId
Gets the identifier of the document of the element.
Declaration
public readonly DocumentId DocumentId { get; }Property Value
| Type | Description |
|---|---|
| DocumentId |
Id
Gets the identifier of the element within its document.
Declaration
public readonly int Id { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
IsEmpty
Tells whether the element identifier is empty.
Declaration
public readonly bool IsEmpty { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Equals(Object)
Declaration
public override bool Equals(object inObject)Parameters
| Type | Name | Description |
|---|---|---|
| Object | inObject |
Returns
| Type | Description |
|---|---|
| Boolean |
Overrides
Equals(ElementId)
Declaration
public bool Equals(ElementId other)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | other |
Returns
| Type | Description |
|---|---|
| Boolean |
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 |
Overrides
Operators
Equality(ElementId, ElementId)
Tells whether two element identifiers are equal.
Declaration
public static bool operator ==(ElementId inElementId1, ElementId inElementId2)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId1 | First element identifier. |
| ElementId | inElementId2 | Second element identifier. |
Returns
| Type | Description |
|---|---|
| Boolean | Element identifiers are equal. |
Inequality(ElementId, ElementId)
Tells whether two element identifiers are different.
Declaration
public static bool operator !=(ElementId inElementId1, ElementId inElementId2)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId1 | First element identifier. |
| ElementId | inElementId2 | Second element identifier. |
Returns
| Type | Description |
|---|---|
| Boolean | Element identifiers are different. |