Documentation

Class DocumentStructureCollection

Inheritance
System.Object
DocumentStructureCollection
Namespace: Telerik.Windows.Documents.DocumentStructure
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class DocumentStructureCollection : Object

Constructors

DocumentStructureCollection(LayoutBox)

Declaration
public DocumentStructureCollection(LayoutBox rootBox)
Parameters
LayoutBox rootBox

DocumentStructureCollection(LayoutElement)

Declaration
public DocumentStructureCollection(LayoutElement layoutElement)
Parameters
LayoutElement layoutElement

Properties

EnumerationStack

Declaration
public BoxParentsStack EnumerationStack { get; }
Property Value
BoxParentsStack

Methods

AddChild(LayoutBox, LayoutBox)

Declaration
public void AddChild(LayoutBox parent, LayoutBox child)
Parameters
LayoutBox parent

LayoutBox child

AddContainerChildBefore(LayoutBox, LayoutBox)

Declaration
public void AddContainerChildBefore(LayoutBox parent, LayoutBox newBox)
Parameters
LayoutBox parent

LayoutBox newBox

AddContainerChildBox(LayoutBox, LayoutBox)

Declaration
public void AddContainerChildBox(LayoutBox parent, LayoutBox child)
Parameters
LayoutBox parent

LayoutBox child

AddContainerSiblingAfter(LayoutBox, LayoutBox)

Declaration
public void AddContainerSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)
Parameters
LayoutBox layoutBox

LayoutBox newSibling

AddContainerSiblingBefore(LayoutBox, LayoutBox)

Declaration
public void AddContainerSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)
Parameters
LayoutBox layoutBox

LayoutBox newSibling

AddLeafChildBox(LayoutBox, LayoutBox)

Declaration
public void AddLeafChildBox(LayoutBox parent, LayoutBox child)
Parameters
LayoutBox parent

LayoutBox child

AddLeafSiblingAfter(LayoutBox, LayoutBox)

Declaration
public void AddLeafSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)
Parameters
LayoutBox layoutBox

LayoutBox newSibling

AddLeafSiblingBefore(LayoutBox, LayoutBox)

Declaration
public void AddLeafSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)
Parameters
LayoutBox layoutBox

LayoutBox newSibling

AddSiblingAfter(LayoutBox, LayoutBox)

Declaration
public void AddSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)
Parameters
LayoutBox layoutBox

LayoutBox newSibling

AddSiblingBefore(LayoutBox, LayoutBox)

Declaration
public void AddSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)
Parameters
LayoutBox layoutBox

LayoutBox newSibling

ClearChildren(LayoutBox)

Declaration
public void ClearChildren(LayoutBox layoutBoxParent)
Parameters
LayoutBox layoutBoxParent

GetChildrenCount(LayoutBox)

Declaration
public static int GetChildrenCount(LayoutBox box)
Parameters
LayoutBox box

Returns
System.Int32

GetFirstChild(LayoutBox)

Declaration
public static LayoutBox GetFirstChild(LayoutBox box)
Parameters
LayoutBox box

Returns
LayoutBox

GetLastChild(LayoutBox)

Declaration
public static LayoutBox GetLastChild(LayoutBox box)
Parameters
LayoutBox box

Returns
LayoutBox

GetNextAssociatedLayoutBox(LayoutBox, DocumentElement)

Declaration
public static LayoutBox GetNextAssociatedLayoutBox(LayoutBox box, DocumentElement associatedDocumentElement)
Parameters
LayoutBox box

DocumentElement associatedDocumentElement

Returns
LayoutBox

GetNextElementOfSameType(LayoutBox)

Declaration
public static LayoutBox GetNextElementOfSameType(LayoutBox box)
Parameters
LayoutBox box

Returns
LayoutBox

GetNextElementOfType(LayoutBox, Type)

Declaration
public static LayoutBox GetNextElementOfType(LayoutBox box, Type type)
Parameters
LayoutBox box

System.Type type

Returns
LayoutBox

GetNextSibling(LayoutBox)

Declaration
public static LayoutBox GetNextSibling(LayoutBox box)
Parameters
LayoutBox box

Returns
LayoutBox

GetNextSiblingForDocumentElement(LayoutBox, DocumentElement)

Declaration
public static LayoutBox GetNextSiblingForDocumentElement(LayoutBox box, DocumentElement owner)
Parameters
LayoutBox box

DocumentElement owner

Returns
LayoutBox

GetNextSiblingForDocumentElementOnSameLevel(LayoutBox, DocumentElement)

Declaration
public static LayoutBox GetNextSiblingForDocumentElementOnSameLevel(LayoutBox box, DocumentElement owner)
Parameters
LayoutBox box

DocumentElement owner

Returns
LayoutBox

GetParent(LayoutBox)

Declaration
public static LayoutBox GetParent(LayoutBox child)
Parameters
LayoutBox child

Returns
LayoutBox

GetPreviousElementOfSameType(LayoutBox)

Declaration
public static LayoutBox GetPreviousElementOfSameType(LayoutBox box)
Parameters
LayoutBox box

Returns
LayoutBox

GetPreviousElementOfType(LayoutBox, Type)

Declaration
public static LayoutBox GetPreviousElementOfType(LayoutBox box, Type type)
Parameters
LayoutBox box

System.Type type

Returns
LayoutBox

GetPreviousSibling(LayoutBox)

Declaration
public static LayoutBox GetPreviousSibling(LayoutBox box)
Parameters
LayoutBox box

Returns
LayoutBox

GetPreviousSiblingForDocumentElement(LayoutBox, DocumentElement)

Declaration
public static LayoutBox GetPreviousSiblingForDocumentElement(LayoutBox box, DocumentElement owner)
Parameters
LayoutBox box

DocumentElement owner

Returns
LayoutBox

GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox, DocumentElement)

Declaration
public static LayoutBox GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox box, DocumentElement owner)
Parameters
LayoutBox box

DocumentElement owner

Returns
LayoutBox

GetRootBox()

Declaration
public DocumentLayoutBox GetRootBox()
Returns
DocumentLayoutBox

HasChildren(LayoutBox)

Declaration
public static bool HasChildren(LayoutBox box)
Parameters
LayoutBox box

Returns
System.Boolean

MergeContainers()

Declaration
public void MergeContainers()

MergeContainers(LayoutBox)

Declaration
public void MergeContainers(LayoutBox fromBox)
Parameters
LayoutBox fromBox

MergeLongWords(ParagraphLayoutBox)

Declaration
public void MergeLongWords(ParagraphLayoutBox paragraphLayoutBox)
Parameters
ParagraphLayoutBox paragraphLayoutBox

MergeLongWordsFromBox(InlineLayoutBox, DocumentElement)

Declaration
public void MergeLongWordsFromBox(InlineLayoutBox layoutBox, DocumentElement associatedDocumentElement)
Parameters
InlineLayoutBox layoutBox

DocumentElement associatedDocumentElement

MergeTableRowBoxes(TableRowLayoutBox, TableRowLayoutBox)

Declaration
public void MergeTableRowBoxes(TableRowLayoutBox firstRow, TableRowLayoutBox secondRow)
Parameters
TableRowLayoutBox firstRow

TableRowLayoutBox secondRow

MergeTwoLayoutBoxes(LayoutBox, LayoutBox, Boolean)

Declaration
public void MergeTwoLayoutBoxes(LayoutBox firstBox, LayoutBox secondBox, bool shouldFinalizeRemoval = true)
Parameters
LayoutBox firstBox

LayoutBox secondBox

System.Boolean shouldFinalizeRemoval

RemoveChild(LayoutBox)

Declaration
public void RemoveChild(LayoutBox child)
Parameters
LayoutBox child

RemoveLastChild(LayoutBox)

Declaration
public void RemoveLastChild(LayoutBox parent)
Parameters
LayoutBox parent

RemoveLeafSiblingAfter(LayoutBox)

Declaration
public void RemoveLeafSiblingAfter(LayoutBox layoutBox)
Parameters
LayoutBox layoutBox

ReplaceLayoutBox(LayoutBox, SpanLayoutBox)

Declaration
public static void ReplaceLayoutBox(LayoutBox boxWithNodeToUpdate, SpanLayoutBox newNodeValue)
Parameters
LayoutBox boxWithNodeToUpdate

SpanLayoutBox newNodeValue

SplitContainer(LayoutBox, LayoutBox, LayoutBox)

Declaration
public void SplitContainer(LayoutBox boxToSplit, LayoutBox fromLayoutBox, LayoutBox newLayoutBox)
Parameters
LayoutBox boxToSplit

LayoutBox fromLayoutBox

LayoutBox newLayoutBox

ToString()

Declaration
public override string ToString()
Returns
System.String

Extension Methods