Class
HierarchicalIndex

Represents the index of a position in a RadDocument.

Definition

Namespace:Telerik.Windows.Documents

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition

public class HierarchicalIndex : IComparable<HierarchicalIndex>

Inheritance: objectHierarchicalIndex

Implements: IComparable<HierarchicalIndex>

Constructors

HierarchicalIndex(int[], int)

Initializes a new instance of the HierarchicalIndex class.

Declaration

cs-api-definition

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

Parameters

indexArray

int[]

The index array.

positionInInline

int

The position in inline.

Methods

CompareTo(HierarchicalIndex)

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

Declaration

cs-api-definition

public int CompareTo(HierarchicalIndex other)

Parameters

other

HierarchicalIndex

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.

Declaration

cs-api-definition

public override bool Equals(object obj)

Parameters

obj

object

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.

Declaration

cs-api-definition

public static LayoutBox GetBoxByHierarchicalIndex(DocumentLayoutBox documentBox, HierarchicalIndex hierarchicalIndex)

Parameters

documentBox

DocumentLayoutBox

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

cs-api-definition

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.

Declaration

cs-api-definition

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

Parameters

currentBox

LayoutBox

A layout box.

indexInInline

int

Optional index in case the box is InlineLayoutBox.

Returns

HierarchicalIndex

The hierarchical index.

GetIndexArray()

Gets an integer array representing the hierarchical index.

Declaration

cs-api-definition

public int[] GetIndexArray()

Returns

int[]

An integer array representing the hierarchical index.

ToString()

Returns a string that represents this instance.

Declaration

cs-api-definition

public override string ToString()

Returns

string

A string that represents this instance.

Overrides object.ToString()

Extension Methods

ExtensionMethods.GetElement<T>(HierarchicalIndex, RadDocument)

ClassHierarchicalIndex

Class
HierarchicalIndex