Struct ElementItemId

Represents an element item identifier.

Implements

System.IEquatable<ElementItemId>

Inherited Members

System.ValueType.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 7, 0, 0)]
public struct ElementItemId : IEquatable<ElementItemId>

Remarks

An element item identifier uniquely identifies an element item, it is made of an element identifier that uniquely identifies the element, and an item label that uniquely identifies the item within the element.

This structure is available since v7.7.

Constructors

ElementItemId(ElementId, ItemLabel)

Initializes a new instance of the ElementItemId structure.

Declaration

public ElementItemId(ElementId inElementId, ItemLabel inItemLabel)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element.
ItemLabel	inItemLabel	Label of the item within its element.

Fields

Empty

Empty identifier.

Declaration

public static readonly ElementItemId Empty

Field Value

Type	Description
ElementItemId

Properties

DocumentId

Gets the identifier of the document of the element.

Declaration

public readonly DocumentId DocumentId { get; }

Property Value

Type	Description
DocumentId

ElementId

Gets the identifier of the element.

Declaration

public readonly ElementId ElementId { get; }

Property Value

Type	Description
ElementId

IsEmpty

Tells whether the element item identifier is empty.

Declaration

public readonly bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean

ItemLabel

Gets the label of the item within the element.

Declaration

public readonly ItemLabel ItemLabel { get; }

Property Value

Type	Description
ItemLabel

ItemType

Gets the type of the item within the element.

Declaration

public readonly byte ItemType { get; }

Property Value

Type	Description
System.Byte

Remarks

Some types are defined in the ItemType enum.

Methods

Equals(Object)

Declaration

public override bool Equals(object inObject)

Parameters

Type	Name	Description
System.Object	inObject

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

Equals(ElementItemId)

Declaration

public bool Equals(ElementItemId other)

Parameters

Type	Name	Description
ElementItemId	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

Operators

Equality(ElementItemId, ElementItemId)

Tells whether two element item identifiers are equal.

Declaration

public static bool operator ==(ElementItemId inElementItemId1, ElementItemId inElementItemId2)

Parameters

Type	Name	Description
ElementItemId	inElementItemId1	First element item identifier.
ElementItemId	inElementItemId2	Second element item identifier.

Returns

Type	Description
System.Boolean	Element item identifiers are equal.

Inequality(ElementItemId, ElementItemId)

Tells whether two element item identifiers are different.

Declaration

public static bool operator !=(ElementItemId inElementItemId1, ElementItemId inElementItemId2)

Parameters

Type	Name	Description
ElementItemId	inElementItemId1	First element item identifier.
ElementItemId	inElementItemId2	Second element item identifier.

Returns

Type	Description
System.Boolean	Element item identifiers are different.

Implements

System.IEquatable<T>