New to Telerik UI for WinForms? Start a free 30-day trial

HierarchicalIndex

Class

Represents the index of a position in a RadDocument.

Definition

Namespace:Telerik.WinForms.Documents

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public class HierarchicalIndex : IComparable<HierarchicalIndex>

Inheritance: objectHierarchicalIndex

Implements: IComparable<HierarchicalIndex>

Constructors

HierarchicalIndex(int[], int)

Initializes a new instance of the HierarchicalIndex class.

public HierarchicalIndex(int[] indexArray, int positionInInline = 0)

Parameters:indexArrayint[]

The index array.

positionInInlineint

The position in inline.

Methods

CompareTo(HierarchicalIndex)

Compares the current object with another object of the same type.

public int CompareTo(HierarchicalIndex other)

Parameters:otherHierarchicalIndex

An object to compare with this object.

Returns:

int

A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other.

Implements: IComparable<HierarchicalIndex>.CompareTo(HierarchicalIndex)

Equals(object)

Determines whether the specified object, is equal to this instance.

public override bool Equals(object obj)

Parameters:objobject

The object to compare with this instance.

Returns:

bool

true if the specified object is equal to this instance; otherwise, false.

Overrides: object.Equals(object)

GetBoxByHierarchicalIndex(DocumentLayoutBox, HierarchicalIndex)

Gets a layout box by its hierarchical index.

public static LayoutBox GetBoxByHierarchicalIndex(DocumentLayoutBox documentBox, HierarchicalIndex hierarchicalIndex)

Parameters:documentBoxDocumentLayoutBox

The layout box of the parent document.

hierarchicalIndexHierarchicalIndex

The hierarchical index of the layout box.

Returns:

LayoutBox

The layout box.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns:

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides: object.GetHashCode()

GetHierarchicalIndexByBox(LayoutBox, int)

Gets the hierarchical index for a layout box.

public static HierarchicalIndex GetHierarchicalIndexByBox(LayoutBox currentBox, int indexInInline = 0)

Parameters:currentBoxLayoutBox

A layout box.

indexInInlineint

Optional index in case the box is InlineLayoutBox.

Returns:

HierarchicalIndex

The hierarchical index.

GetIndexArray()

Gets an integer array representing the hierarchical index.

public int[] GetIndexArray()

Returns:

int[]

An integer array representing the hierarchical index.

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns:

string

A string that represents this instance.

Overrides: object.ToString()

Extension Methods

ExtensionMethods.GetElement<T>(HierarchicalIndex, RadDocument)