Back to all docs
API Reference / Telerik.WinForms.Documents.DocumentStructure / DocumentStructureCollection

Class
DocumentStructureCollection

Definition

Namespace:Telerik.WinForms.Documents.DocumentStructure

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:
cs-api-definition
public class DocumentStructureCollection

Inheritance: objectDocumentStructureCollection

Constructors

DocumentStructureCollection(LayoutBox)

Declaration

cs-api-definition
public DocumentStructureCollection(LayoutBox rootBox)

Parameters

rootBox

LayoutBox

DocumentStructureCollection(LayoutElement)

Declaration

cs-api-definition
public DocumentStructureCollection(LayoutElement layoutElement)

Parameters

layoutElement

LayoutElement

Properties

EnumerationStack

Declaration

cs-api-definition
public BoxParentsStack EnumerationStack { get; }

Property Value

BoxParentsStack

Methods

AddChild(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddChild(LayoutBox parent, LayoutBox child)

Parameters

parent

LayoutBox

child

LayoutBox

AddContainerChildBefore(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddContainerChildBefore(LayoutBox parent, LayoutBox newBox)

Parameters

parent

LayoutBox

newBox

LayoutBox

AddContainerChildBox(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddContainerChildBox(LayoutBox parent, LayoutBox child)

Parameters

parent

LayoutBox

child

LayoutBox

AddContainerSiblingAfter(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddContainerSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)

Parameters

layoutBox

LayoutBox

newSibling

LayoutBox

AddContainerSiblingBefore(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddContainerSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)

Parameters

layoutBox

LayoutBox

newSibling

LayoutBox

AddLeafChildBox(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddLeafChildBox(LayoutBox parent, LayoutBox child)

Parameters

parent

LayoutBox

child

LayoutBox

AddLeafSiblingAfter(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddLeafSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)

Parameters

layoutBox

LayoutBox

newSibling

LayoutBox

AddLeafSiblingBefore(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddLeafSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)

Parameters

layoutBox

LayoutBox

newSibling

LayoutBox

AddSiblingAfter(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddSiblingAfter(LayoutBox layoutBox, LayoutBox newSibling)

Parameters

layoutBox

LayoutBox

newSibling

LayoutBox

AddSiblingBefore(LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void AddSiblingBefore(LayoutBox layoutBox, LayoutBox newSibling)

Parameters

layoutBox

LayoutBox

newSibling

LayoutBox

ClearChildren(LayoutBox)

Declaration

cs-api-definition
public void ClearChildren(LayoutBox layoutBoxParent)

Parameters

layoutBoxParent

LayoutBox

GetChildrenCount(LayoutBox)

Declaration

cs-api-definition
public static int GetChildrenCount(LayoutBox box)

Parameters

box

LayoutBox

Returns

int

GetFirstChild(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetFirstChild(LayoutBox box)

Parameters

box

LayoutBox

Returns

LayoutBox

GetLastChild(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetLastChild(LayoutBox box)

Parameters

box

LayoutBox

Returns

LayoutBox

GetNextAssociatedLayoutBox(LayoutBox, DocumentElement)

Declaration

cs-api-definition
public static LayoutBox GetNextAssociatedLayoutBox(LayoutBox box, DocumentElement associatedDocumentElement)

Parameters

box

LayoutBox

associatedDocumentElement

DocumentElement

Returns

LayoutBox

GetNextElementOfSameType(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetNextElementOfSameType(LayoutBox box)

Parameters

box

LayoutBox

Returns

LayoutBox

GetNextElementOfType(LayoutBox, Type)

Declaration

cs-api-definition
public static LayoutBox GetNextElementOfType(LayoutBox box, Type type)

Parameters

box

LayoutBox

type

Type

Returns

LayoutBox

GetNextSibling(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetNextSibling(LayoutBox box)

Parameters

box

LayoutBox

Returns

LayoutBox

GetNextSiblingForDocumentElement(LayoutBox, DocumentElement)

Declaration

cs-api-definition
public static LayoutBox GetNextSiblingForDocumentElement(LayoutBox box, DocumentElement owner)

Parameters

box

LayoutBox

owner

DocumentElement

Returns

LayoutBox

GetNextSiblingForDocumentElementOnSameLevel(LayoutBox, DocumentElement)

Declaration

cs-api-definition
public static LayoutBox GetNextSiblingForDocumentElementOnSameLevel(LayoutBox box, DocumentElement owner)

Parameters

box

LayoutBox

owner

DocumentElement

Returns

LayoutBox

GetParent(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetParent(LayoutBox child)

Parameters

child

LayoutBox

Returns

LayoutBox

GetPreviousElementOfSameType(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetPreviousElementOfSameType(LayoutBox box)

Parameters

box

LayoutBox

Returns

LayoutBox

GetPreviousElementOfType(LayoutBox, Type)

Declaration

cs-api-definition
public static LayoutBox GetPreviousElementOfType(LayoutBox box, Type type)

Parameters

box

LayoutBox

type

Type

Returns

LayoutBox

GetPreviousSibling(LayoutBox)

Declaration

cs-api-definition
public static LayoutBox GetPreviousSibling(LayoutBox box)

Parameters

box

LayoutBox

Returns

LayoutBox

GetPreviousSiblingForDocumentElement(LayoutBox, DocumentElement)

Declaration

cs-api-definition
public static LayoutBox GetPreviousSiblingForDocumentElement(LayoutBox box, DocumentElement owner)

Parameters

box

LayoutBox

owner

DocumentElement

Returns

LayoutBox

GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox, DocumentElement)

Declaration

cs-api-definition
public static LayoutBox GetPreviousSiblingForDocumentElementOnSamelevel(LayoutBox box, DocumentElement owner)

Parameters

box

LayoutBox

owner

DocumentElement

Returns

LayoutBox

GetRootBox()

Declaration

cs-api-definition
public DocumentLayoutBox GetRootBox()

Returns

DocumentLayoutBox

HasChildren(LayoutBox)

Declaration

cs-api-definition
public static bool HasChildren(LayoutBox box)

Parameters

box

LayoutBox

Returns

bool

MergeContainers()

Declaration

cs-api-definition
public void MergeContainers()

MergeContainers(LayoutBox)

Declaration

cs-api-definition
public void MergeContainers(LayoutBox fromBox)

Parameters

fromBox

LayoutBox

MergeLongWords(ParagraphLayoutBox)

Declaration

cs-api-definition
public void MergeLongWords(ParagraphLayoutBox paragraphLayoutBox)

Parameters

paragraphLayoutBox

ParagraphLayoutBox

MergeLongWordsFromBox(InlineLayoutBox, DocumentElement)

Declaration

cs-api-definition
public void MergeLongWordsFromBox(InlineLayoutBox layoutBox, DocumentElement associatedDocumentElement)

Parameters

layoutBox

InlineLayoutBox

associatedDocumentElement

DocumentElement

MergeTableRowBoxes(TableRowLayoutBox, TableRowLayoutBox)

Declaration

cs-api-definition
public void MergeTableRowBoxes(TableRowLayoutBox firstRow, TableRowLayoutBox secondRow)

Parameters

firstRow

TableRowLayoutBox

secondRow

TableRowLayoutBox

MergeTwoLayoutBoxes(LayoutBox, LayoutBox, bool)

Declaration

cs-api-definition
public void MergeTwoLayoutBoxes(LayoutBox firstBox, LayoutBox secondBox, bool shouldFinalizeRemoval = true)

Parameters

firstBox

LayoutBox

secondBox

LayoutBox

shouldFinalizeRemoval

bool

RemoveChild(LayoutBox)

Declaration

cs-api-definition
public void RemoveChild(LayoutBox child)

Parameters

child

LayoutBox

RemoveLastChild(LayoutBox)

Declaration

cs-api-definition
public void RemoveLastChild(LayoutBox parent)

Parameters

parent

LayoutBox

RemoveLeafSiblingAfter(LayoutBox)

Declaration

cs-api-definition
public void RemoveLeafSiblingAfter(LayoutBox layoutBox)

Parameters

layoutBox

LayoutBox

ReplaceLayoutBox(LayoutBox, SpanLayoutBox)

Declaration

cs-api-definition
public static void ReplaceLayoutBox(LayoutBox boxWithNodeToUpdate, SpanLayoutBox newNodeValue)

Parameters

boxWithNodeToUpdate

LayoutBox

newNodeValue

SpanLayoutBox

SplitContainer(LayoutBox, LayoutBox, LayoutBox)

Declaration

cs-api-definition
public void SplitContainer(LayoutBox boxToSplit, LayoutBox fromLayoutBox, LayoutBox newLayoutBox)

Parameters

boxToSplit

LayoutBox

fromLayoutBox

LayoutBox

newLayoutBox

LayoutBox

ToString()

Declaration

cs-api-definition
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