Back to all docs
API Reference / Telerik.WinForms.Documents.DocumentStructure / DocumentStructureCollection
New to Telerik UI for WinForms? Start a free 30-day trial

DocumentStructureCollection

Class

Definition

Namespace:Telerik.WinForms.Documents.DocumentStructure

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:
C#
public class DocumentStructureCollection

Inheritance: objectDocumentStructureCollection

Constructors

DocumentStructureCollection(LayoutBox)

C#
public DocumentStructureCollection(LayoutBox rootBox)
Parameters:rootBoxLayoutBox

DocumentStructureCollection(LayoutElement)

C#
public DocumentStructureCollection(LayoutElement layoutElement)
Parameters:layoutElementLayoutElement

Properties

EnumerationStack

C#
public BoxParentsStack EnumerationStack { get; }

Methods

AddChild(LayoutBox, LayoutBox)

C#
public void AddChild(LayoutBox parent, LayoutBox child)
Parameters:parentLayoutBoxchildLayoutBox

AddContainerChildBefore(LayoutBox, LayoutBox)

C#
public void AddContainerChildBefore(LayoutBox parent, LayoutBox newBox)
Parameters:parentLayoutBoxnewBoxLayoutBox

AddContainerChildBox(LayoutBox, LayoutBox)

C#
public void AddContainerChildBox(LayoutBox parent, LayoutBox child)
Parameters:parentLayoutBoxchildLayoutBox

AddContainerSiblingAfter(LayoutBox, LayoutBox)

C#
public void AddContainerSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)
Parameters:layoutBoxLayoutBoxnewSiblingLayoutBox

AddContainerSiblingBefore(LayoutBox, LayoutBox)

C#
public void AddContainerSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)
Parameters:layoutBoxLayoutBoxnewSiblingLayoutBox

AddLeafChildBox(LayoutBox, LayoutBox)

C#
public void AddLeafChildBox(LayoutBox parent, LayoutBox child)
Parameters:parentLayoutBoxchildLayoutBox

AddLeafSiblingAfter(LayoutBox, LayoutBox)

C#
public void AddLeafSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)
Parameters:layoutBoxLayoutBoxnewSiblingLayoutBox

AddLeafSiblingBefore(LayoutBox, LayoutBox)

C#
public void AddLeafSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)
Parameters:layoutBoxLayoutBoxnewSiblingLayoutBox

AddSiblingAfter(LayoutBox, LayoutBox)

C#
public void AddSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)
Parameters:layoutBoxLayoutBoxnewSiblingLayoutBox

AddSiblingBefore(LayoutBox, LayoutBox)

C#
public void AddSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)
Parameters:layoutBoxLayoutBoxnewSiblingLayoutBox

ClearChildren(LayoutBox)

C#
public void ClearChildren(LayoutBox layoutBoxParent)
Parameters:layoutBoxParentLayoutBox

GetChildrenCount(LayoutBox)

C#
public static int GetChildrenCount(LayoutBox box)
Parameters:boxLayoutBoxReturns:

int

GetFirstChild(LayoutBox)

C#
public static LayoutBox GetFirstChild(LayoutBox box)
Parameters:boxLayoutBoxReturns:

LayoutBox

GetLastChild(LayoutBox)

C#
public static LayoutBox GetLastChild(LayoutBox box)
Parameters:boxLayoutBoxReturns:

LayoutBox

GetNextAssociatedLayoutBox(LayoutBox, DocumentElement)

C#
public static LayoutBox GetNextAssociatedLayoutBox(LayoutBox box, DocumentElement associatedDocumentElement)
Parameters:boxLayoutBoxassociatedDocumentElementDocumentElementReturns:

LayoutBox

GetNextElementOfSameType(LayoutBox)

C#
public static LayoutBox GetNextElementOfSameType(LayoutBox box)
Parameters:boxLayoutBoxReturns:

LayoutBox

GetNextElementOfType(LayoutBox, Type)

C#
public static LayoutBox GetNextElementOfType(LayoutBox box, Type type)
Parameters:boxLayoutBoxtypeTypeReturns:

LayoutBox

GetNextSibling(LayoutBox)

C#
public static LayoutBox GetNextSibling(LayoutBox box)
Parameters:boxLayoutBoxReturns:

LayoutBox

GetNextSiblingForDocumentElement(LayoutBox, DocumentElement)

C#
public static LayoutBox GetNextSiblingForDocumentElement(LayoutBox box, DocumentElement owner)
Parameters:boxLayoutBoxownerDocumentElementReturns:

LayoutBox

GetNextSiblingForDocumentElementOnSameLevel(LayoutBox, DocumentElement)

C#
public static LayoutBox GetNextSiblingForDocumentElementOnSameLevel(LayoutBox box, DocumentElement owner)
Parameters:boxLayoutBoxownerDocumentElementReturns:

LayoutBox

GetParent(LayoutBox)

C#
public static LayoutBox GetParent(LayoutBox child)
Parameters:childLayoutBoxReturns:

LayoutBox

GetPreviousElementOfSameType(LayoutBox)

C#
public static LayoutBox GetPreviousElementOfSameType(LayoutBox box)
Parameters:boxLayoutBoxReturns:

LayoutBox

GetPreviousElementOfType(LayoutBox, Type)

C#
public static LayoutBox GetPreviousElementOfType(LayoutBox box, Type type)
Parameters:boxLayoutBoxtypeTypeReturns:

LayoutBox

GetPreviousSibling(LayoutBox)

C#
public static LayoutBox GetPreviousSibling(LayoutBox box)
Parameters:boxLayoutBoxReturns:

LayoutBox

GetPreviousSiblingForDocumentElement(LayoutBox, DocumentElement)

C#
public static LayoutBox GetPreviousSiblingForDocumentElement(LayoutBox box, DocumentElement owner)
Parameters:boxLayoutBoxownerDocumentElementReturns:

LayoutBox

GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox, DocumentElement)

C#
public static LayoutBox GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox box, DocumentElement owner)
Parameters:boxLayoutBoxownerDocumentElementReturns:

LayoutBox

GetRootBox()

C#
public DocumentLayoutBox GetRootBox()
Returns:

DocumentLayoutBox

HasChildren(LayoutBox)

C#
public static bool HasChildren(LayoutBox box)
Parameters:boxLayoutBoxReturns:

bool

MergeContainers()

C#
public void MergeContainers()

MergeContainers(LayoutBox)

C#
public void MergeContainers(LayoutBox fromBox)
Parameters:fromBoxLayoutBox

MergeLongWords(ParagraphLayoutBox)

C#
public void MergeLongWords(ParagraphLayoutBox paragraphLayoutBox)
Parameters:paragraphLayoutBoxParagraphLayoutBox

MergeLongWordsFromBox(InlineLayoutBox, DocumentElement)

C#
public void MergeLongWordsFromBox(InlineLayoutBox layoutBox, DocumentElement associatedDocumentElement)
Parameters:layoutBoxInlineLayoutBoxassociatedDocumentElementDocumentElement

MergeTableRowBoxes(TableRowLayoutBox, TableRowLayoutBox)

C#
public void MergeTableRowBoxes(TableRowLayoutBox firstRow, TableRowLayoutBox secondRow)
Parameters:firstRowTableRowLayoutBoxsecondRowTableRowLayoutBox

MergeTwoLayoutBoxes(LayoutBox, LayoutBox, bool)

C#
public void MergeTwoLayoutBoxes(LayoutBox firstBox, LayoutBox secondBox, bool shouldFinalizeRemoval = true)
Parameters:firstBoxLayoutBoxsecondBoxLayoutBoxshouldFinalizeRemovalbool

RemoveChild(LayoutBox)

C#
public void RemoveChild(LayoutBox child)
Parameters:childLayoutBox

RemoveLastChild(LayoutBox)

C#
public void RemoveLastChild(LayoutBox parent)
Parameters:parentLayoutBox

RemoveLeafSiblingAfter(LayoutBox)

C#
public void RemoveLeafSiblingAfter(LayoutBox layoutBox)
Parameters:layoutBoxLayoutBox

ReplaceLayoutBox(LayoutBox, SpanLayoutBox)

C#
public static void ReplaceLayoutBox(LayoutBox boxWithNodeToUpdate, SpanLayoutBox newNodeValue)
Parameters:boxWithNodeToUpdateLayoutBoxnewNodeValueSpanLayoutBox

SplitContainer(LayoutBox, LayoutBox, LayoutBox)

C#
public void SplitContainer(LayoutBox boxToSplit, LayoutBox fromLayoutBox, LayoutBox newLayoutBox)
Parameters:boxToSplitLayoutBoxfromLayoutBoxLayoutBoxnewLayoutBoxLayoutBox

ToString()

C#
public override string ToString()
Returns:

string

Overrides: object.ToString()

In this article
DefinitionConstructorsDocumentStructureCollection(LayoutBox)DocumentStructureCollection(LayoutElement)PropertiesEnumerationStackMethodsAddChild(LayoutBox, LayoutBox)AddContainerChildBefore(LayoutBox, LayoutBox)AddContainerChildBox(LayoutBox, LayoutBox)AddContainerSiblingAfter(LayoutBox, LayoutBox)AddContainerSiblingBefore(LayoutBox, LayoutBox)AddLeafChildBox(LayoutBox, LayoutBox)AddLeafSiblingAfter(LayoutBox, LayoutBox)AddLeafSiblingBefore(LayoutBox, LayoutBox)AddSiblingAfter(LayoutBox, LayoutBox)AddSiblingBefore(LayoutBox, LayoutBox)ClearChildren(LayoutBox)GetChildrenCount(LayoutBox)GetFirstChild(LayoutBox)GetLastChild(LayoutBox)GetNextAssociatedLayoutBox(LayoutBox, DocumentElement)GetNextElementOfSameType(LayoutBox)GetNextElementOfType(LayoutBox, Type)GetNextSibling(LayoutBox)GetNextSiblingForDocumentElement(LayoutBox, DocumentElement)GetNextSiblingForDocumentElementOnSameLevel(LayoutBox, DocumentElement)GetParent(LayoutBox)GetPreviousElementOfSameType(LayoutBox)GetPreviousElementOfType(LayoutBox, Type)GetPreviousSibling(LayoutBox)GetPreviousSiblingForDocumentElement(LayoutBox, DocumentElement)GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox, DocumentElement)GetRootBox()HasChildren(LayoutBox)MergeContainers()MergeContainers(LayoutBox)MergeLongWords(ParagraphLayoutBox)MergeLongWordsFromBox(InlineLayoutBox, DocumentElement)MergeTableRowBoxes(TableRowLayoutBox, TableRowLayoutBox)MergeTwoLayoutBoxes(LayoutBox, LayoutBox, bool)RemoveChild(LayoutBox)RemoveLastChild(LayoutBox)RemoveLeafSiblingAfter(LayoutBox)ReplaceLayoutBox(LayoutBox, SpanLayoutBox)SplitContainer(LayoutBox, LayoutBox, LayoutBox)ToString()
Not finding the help you need?
Contact Support