Documentation

Class HierarchicalIndex

Represents the index of a position in a RadDocument.

Inheritance
System.Object
HierarchicalIndex
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Documents
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class HierarchicalIndex : IComparable<HierarchicalIndex>

Constructors

HierarchicalIndex(Int32[], Int32)

Initializes a new instance of the HierarchicalIndex class.

Declaration
public HierarchicalIndex(int[] indexArray, int positionInInline = 0)
Parameters
System.Int32[] indexArray

The index array.
System.Int32 positionInInline

The position in inline.

Methods

CompareTo(HierarchicalIndex)

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

Declaration
public int CompareTo(HierarchicalIndex other)
Parameters
HierarchicalIndex other

An object to compare with this object.
Returns
System.Int32

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
System.IComparable<T>.CompareTo(T)

Equals(Object)

Determines whether the specified System.Object, is equal to this instance.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with this instance.
Returns
System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetBoxByHierarchicalIndex(DocumentLayoutBox, HierarchicalIndex)

Gets a layout box by its hierarchical index.

Declaration
public static LayoutBox GetBoxByHierarchicalIndex(DocumentLayoutBox documentBox, HierarchicalIndex hierarchicalIndex)
Parameters
DocumentLayoutBox documentBox

The layout box of the parent document.
HierarchicalIndex hierarchicalIndex

The hierarchical index of the layout box.
Returns
LayoutBox

The layout box.

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
System.Int32

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

Overrides
System.Object.GetHashCode()

GetHierarchicalIndexByBox(LayoutBox, Int32)

Gets the hierarchical index for a layout box.

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

A layout box.
System.Int32 indexInInline

Optional index in case the box is InlineLayoutBox.
Returns
HierarchicalIndex

The hierarchical index.

GetIndexArray()

Gets an integer array representing the hierarchical index.

Declaration
public int[] GetIndexArray()
Returns
System.Int32[]

An integer array representing the hierarchical index.

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents this instance.
Overrides
System.Object.ToString()

Extension Methods