Class ItemPathInformation

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents information about the path of an item within the organizational hierarchy.

public class ItemPathInformation : GlobalSerializableClassicBase, IComparable<ItemPathInformation>

Inheritance

object

ItemPathInformation

Implements

IComparable<ItemPathInformation>

Constructors

ItemPathInformation()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.ItemPathInformation class.

public ItemPathInformation()

Properties

ItemID

Gets or sets the unique ID of the item for which the path information is provided.

public int ItemID { get; set; }

Property Value

int

ItemPathIdentifiers

Gets or sets the path to the item as item identifiers from the root item.

public SerializableIntegerCollection ItemPathIdentifiers { get; set; }

Property Value

SerializableIntegerCollection

ItemPathNames

Gets or sets the path to the item as item names from the root item.

public SerializableStringCollection ItemPathNames { get; set; }

Property Value

SerializableStringCollection

ItemPathString

Gets the full path to where the item is stored as a human readable string.

public string ItemPathString { get; set; }

Property Value

string

Methods

CompareTo(ItemPathInformation)

Compares two item path information objects, allowing them to be sorted in the order they exist in the hierarchy.

public int CompareTo(ItemPathInformation other)

Parameters

other ItemPathInformation

The item path information object to compare to.

Returns

int

The order in which the item path information objects are to be sorted.

ToString()

Returns the path information as a human readable string.

public override string ToString()

Returns

string

The path information as a human readable string.