Class Container

Represents a container element within a Word document, which can hold other content elements like paragraphs, tables, and images.

Inheritance
System.Object
ContentElement
ParentElement
Container
Implements
IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
IronSoftware.Abstractions.IParent<IronSoftware.Abstractions.Word.IWordDocumentObjectCollection, IronSoftware.Abstractions.Word.IWordDocumentObject>
Inherited Members
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Container : ParentElement, IWordDocumentObject, IDocumentObject, ICloneable, IParent<IWordDocumentObjectCollection, IWordDocumentObject>
Remarks

Equivalent to the "body" of a Word document.

Constructors

Container()

Initializes a new instance of the Container class.

Declaration
public Container()

Container(ContentElement[])

Initializes a new instance of the Container class with the specified child elements.

Declaration
public Container(params ContentElement[] children)
Parameters
Type Name Description
ContentElement[] children

The child elements to be added.

Properties

BuiltInColors

Gets or sets the list of built-in and custom colors in the document.

Declaration
public Dictionary<string, Dictionary<string, Color>> BuiltInColors { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.Dictionary<System.String, Color>>

BuiltInStyles

Gets or sets the list of built-in and custom styles in the document.

Declaration
public Dictionary<string, BaseStyle> BuiltInStyles { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, BaseStyle>

DefaultParagraphStyle

Gets or sets the document paragraph default style.

Declaration
public ParagraphStyle DefaultParagraphStyle { get; set; }
Property Value
Type Description
ParagraphStyle

DefaultTableStyle

Gets or sets the document default table style.

Declaration
public TableStyle DefaultTableStyle { get; set; }
Property Value
Type Description
TableStyle

DefaultTextStyle

Gets or sets the document default text style.

Declaration
public TextStyle DefaultTextStyle { get; set; }
Property Value
Type Description
TextStyle

Methods

AddChild(IWordDocumentObject[])

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

Declaration
public override void AddChild(params IWordDocumentObject[] children)
Parameters
Type Name Description
IronSoftware.Abstractions.Word.IWordDocumentObject[] children

The content elements to be added as children.
Overrides
Remarks

Paragraphs, runs, images, shapes, and text will automatically be added to the last section in the document.

Implements

IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
IronSoftware.Abstractions.IParent<, >

Inherited members

InsertChildToIndex(Int32, IWordDocumentObject[])
Remove()
RemoveChildren(IWordDocumentObject[])
RemoveAllChildren()
ExtractElements<T>()
GetChildByIndex<T>(Int32)
Clone()
CloneObject()
LogObjectTree()
Texts
Tables
Children
Replace(IWordDocumentObject)
GetIndex<T>()
Parent
Status