Interface IElementContainer

Represents a container for various document elements, including text, drawings, paragraphs, tables, and multi-level text lists.

Inherited Members
Namespace: IronWord.Models.Abstract.Interfaces
Assembly: IronWord.dll
Syntax
public interface IElementContainer : ITextContainer, IDrawContainer

When a document part has to carry every kind of body content at once, text, drawings, paragraphs, tables, and lists, IElementContainer is the IronWord contract that gathers those abilities into one type. It combines the text methods of ITextContainer and the drawing methods of IDrawContainer and then adds the paragraph, table, and list members on top, so a single object can build a full document region.

The concrete implementor is DocumentSection, which is the section you obtain from a document and write the bulk of your content into. Coding against IElementContainer rather than the section type keeps a content-building method reusable and easy to test.

The members worth knowing are AddParagraph, which appends a Paragraph and returns it, AddTable, which appends a Table, and AddMultiLevelTextList, which appends a MultiLevelTextList. The Paragraphs and MultiLevelTextLists properties expose the content already in the container as lists you can read back. Inherited text and drawing calls such as AddText and AddImage are available on the same object.

IElementContainer section = documentSection;
section.AddParagraph(new Paragraph());
section.AddTable(new Table());

The add table how-to and the document element tutorial show how a section is assembled.

Properties

MultiLevelTextLists

Gets the list of MultiLevelTextList elements contained in the element container.

Declaration
List<MultiLevelTextList> MultiLevelTextLists { get; }
Property Value
Type Description
System.Collections.Generic.List<MultiLevelTextList>

Paragraphs

Gets the list of Paragraph elements contained in the element container.

Declaration
List<Paragraph> Paragraphs { get; }
Property Value
Type Description
System.Collections.Generic.List<Paragraph>

Methods

AddMultiLevelTextList(MultiLevelTextList)

Adds a MultiLevelTextList to the element container.

Declaration
MultiLevelTextList AddMultiLevelTextList(MultiLevelTextList multiLevelTextList)
Parameters
Type Name Description
MultiLevelTextList multiLevelTextList

The MultiLevelTextList to be added.
Returns
Type Description
MultiLevelTextList

The added MultiLevelTextList.

AddParagraph(Paragraph)

Adds a Paragraph to the element container.

Declaration
Paragraph AddParagraph(Paragraph paragraph)
Parameters
Type Name Description
Paragraph paragraph

The Paragraph to be added.
Returns
Type Description
Paragraph

The added Paragraph.

AddTable(Table)

Adds a Table to the element container.

Declaration
Table AddTable(Table table)
Parameters
Type Name Description
Table table

The Table to be added.
Returns
Type Description
Table

The added Table.

Inherited members

AddText(String)
AddText(TextContent)
ExtractText()
ReplaceText(String, String)
FindText(String)
Remove(TextContent)
AddShape(ShapeContent)
AddImage(ImageContent)
AddImage(Stream)
AddImage(String)
AddImage(AnyBitmap)
ExtractShapes()
ExtractImages()