Interface IContentElement

Represents an element that can contain and manage child content elements.

Namespace: IronWord.Models.Abstract.Interfaces

Assembly: IronWord.dll

Syntax

public interface IContentElement

Properties

Children

Gets or sets the list of child content elements.

Declaration

List<ContentElement> Children { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ContentElement>

Parent

Gets the parent content element.

Declaration

ContentElement Parent { get; }

Property Value

Type	Description
ContentElement

Methods

AddChild(ContentElement[])

Adds one or more child content elements to the current content element.

Declaration

void AddChild(params ContentElement[] children)

Parameters

Type	Name	Description
ContentElement[]	children	The content elements to be added as children.

Clone()

Creates a deep copy of the content element.

Declaration

ContentElement Clone()

Returns

Type	Description
ContentElement	A new instance of the content element with all properties and child elements copied.

ExtractElements<T>()

Extracts elements of a specified type from the child content elements.

Declaration

List<T> ExtractElements<T>()
    where T : ContentElement

Returns

Type	Description
System.Collections.Generic.List<T>	A list of content elements of the specified type.

Type Parameters

Name	Description
T	The type of content element to extract.

GetChildByIndex<T>(Int32)

Gets the child content element at the specified index and of the specified type.

Declaration

ContentElement GetChildByIndex<T>(int index)
    where T : ContentElement

Parameters

Type	Name	Description
System.Int32	index	The index of the child content element.

Returns

Type	Description
ContentElement	The child content element at the specified index and of the specified type.

Type Parameters

Name	Description
T	The type of content element to retrieve.

InsertChildToIndex(Int32, ContentElement[])

Inserts one or more child content elements at the specified index.

Declaration

void InsertChildToIndex(int index, params ContentElement[] children)

Parameters

Type	Name	Description
System.Int32	index	The index at which the child content elements should be inserted.
ContentElement[]	children	The content elements to be inserted.

Remove()

Removes the current content element from its parent.

Declaration

void Remove()

RemoveAllChildren()

Removes all child content elements from the current content element.

Declaration

void RemoveAllChildren()

RemoveChildren(ContentElement[])

Removes specified child content elements from the current content element.

Declaration

void RemoveChildren(params ContentElement[] children)

Parameters

Type	Name	Description
ContentElement[]	children	The content elements to be removed.

Replace(ContentElement)

Replaces the current content element with a new child content element.

Declaration

void Replace(ContentElement newChild)

Parameters

Type	Name	Description
ContentElement	newChild	The new child content element to replace the current element.