Struct ItemLabel

Represents an element item label.

Implements

System.IEquatable<ItemLabel>

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, 6, 0, 0)]
public struct ItemLabel : IEquatable<ItemLabel>

Remarks

An item label uniquely identifies an item within a specified element.

This structure is available since v7.6.

Constructors

ItemLabel(Byte, Int32, String, String)

Initializes a new instance of the ItemLabel structure.

Declaration

public ItemLabel(byte inType, int inId, string inMoniker, string inName)

Parameters

Type	Name	Description
System.Byte	inType	Type of item, or 0 if none.
System.Int32	inId	Identifier of the item within its element, or 0 if empty.
System.String	inMoniker	Moniker associated to the item that will survive some modification.
System.String	inName	Item name, or null if none.

Fields

Empty

Empty label.

Declaration

public static readonly ItemLabel Empty

Field Value

Type	Description
ItemLabel

Frame2DOrigin

Label of 2D frame origin.

Declaration

public static readonly ItemLabel Frame2DOrigin

Field Value

Type	Description
ItemLabel

Frame2DXAxis

Label of 2D frame X axis.

Declaration

public static readonly ItemLabel Frame2DXAxis

Field Value

Type	Description
ItemLabel

Frame2DYAxis

Label of 2D frame Y axis.

Declaration

public static readonly ItemLabel Frame2DYAxis

Field Value

Type	Description
ItemLabel

Frame3DOrigin

Label of 3D frame origin.

Declaration

public static readonly ItemLabel Frame3DOrigin

Field Value

Type	Description
ItemLabel

Frame3DXAxis

Label of 3D frame X axis.

Declaration

public static readonly ItemLabel Frame3DXAxis

Field Value

Type	Description
ItemLabel

Frame3DXYPlane

Label of 3D frame XY plane.

Declaration

public static readonly ItemLabel Frame3DXYPlane

Field Value

Type	Description
ItemLabel

Frame3DXZPlane

Label of 3D frame XZ plane.

Declaration

public static readonly ItemLabel Frame3DXZPlane

Field Value

Type	Description
ItemLabel

Frame3DYAxis

Label of 3D frame Y axis.

Declaration

public static readonly ItemLabel Frame3DYAxis

Field Value

Type	Description
ItemLabel

Frame3DYZPlane

Label of 3D frame YZ plane.

Declaration

public static readonly ItemLabel Frame3DYZPlane

Field Value

Type	Description
ItemLabel

Frame3DZAxis

Label of 3D frame Z axis.

Declaration

public static readonly ItemLabel Frame3DZAxis

Field Value

Type	Description
ItemLabel

Properties

Id

Gets the identifier of the item within its element, or 0 if empty.

Declaration

public readonly int Id { get; }

Property Value

Type	Description
System.Int32

IsEmpty

Tells whether the item label is empty.

Declaration

public readonly bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean

Moniker

Gets the moniker associated to the item.

Declaration

public readonly string Moniker { get; }

Property Value

Type	Description
System.String

Name

Gets the item name.

Declaration

public readonly string Name { get; }

Property Value

Type	Description
System.String

Type

Gets the type of the item, or 0 if none.

Declaration

public readonly byte Type { 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(ItemLabel)

Declaration

public bool Equals(ItemLabel other)

Parameters

Type	Name	Description
ItemLabel	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

Operators

Equality(ItemLabel, ItemLabel)

Tells whether two item labels are equal.

Declaration

public static bool operator ==(ItemLabel inItemLabel1, ItemLabel inItemLabel2)

Parameters

Type	Name	Description
ItemLabel	inItemLabel1	First item label.
ItemLabel	inItemLabel2	Second item label.

Returns

Type	Description
System.Boolean	Item labels are equal.

Inequality(ItemLabel, ItemLabel)

Tells whether two item labels are different.

Declaration

public static bool operator !=(ItemLabel inItemLabel1, ItemLabel inItemLabel2)

Parameters

Type	Name	Description
ItemLabel	inItemLabel1	First item label.
ItemLabel	inItemLabel2	Second item label.

Returns

Type	Description
System.Boolean	Item labels are different.

Implements

System.IEquatable<T>