Class DocumentSection

Represents a section within a document, containing various content elements like paragraphs, text runs, and tables.

Inheritance

System.Object

ContentElement

ParentElement

DocumentSection

Implements

IronSoftware.Abstractions.IDocumentElement

IronSoftware.IDocumentObject

System.ICloneable

IElementContainer

ITextContainer

IDrawContainer

Inherited Members

ParentElement.AddChild(ContentElement[])

ParentElement.InsertChildToIndex(Int32, ContentElement[])

ParentElement.Remove()

ParentElement.RemoveChildren(ContentElement[])

ParentElement.RemoveAllChildren()

ParentElement.ExtractElements<T>()

ParentElement.GetChildByIndex<T>(Int32)

ParentElement.Clone()

ParentElement.CloneObject()

ParentElement.LogObjectTree()

ParentElement.DefaultTextStyle

ParentElement.Texts

ParentElement.Tables

ParentElement.Children

ContentElement.Status

ContentElement.Replace(ContentElement)

ContentElement.GetIndex<T>()

ContentElement.Parent

ContentElement.ObjNum

ContentElement.PageIndex

ContentElement.DocumentId

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class DocumentSection : ParentElement, IDocumentElement, IDocumentObject, ICloneable, IElementContainer, ITextContainer, IDrawContainer

Constructors

DocumentSection(ContentElement[])

Initializes a new instance of the DocumentSection class.

Declaration

public DocumentSection(params ContentElement[] children)

Parameters

Type	Name	Description
ContentElement[]	children

Properties

BottomMargin

Bottom margin of document section in mm.

Declaration

public double BottomMargin { get; }

Property Value

Type	Description
System.Double

Height

Height of document section in mm.

Declaration

public double Height { get; }

Property Value

Type	Description
System.Double

Index

Gets the index of this section within the parent's list of children.

Declaration

public int Index { get; set; }

Property Value

Type	Description
System.Int32

LeftMargin

Left margin of document section in mm.

Declaration

public double LeftMargin { get; }

Property Value

Type	Description
System.Double

MultiLevelTextLists

Gets a list of all ShapeContent elements contained within this document section.

Declaration

public List<MultiLevelTextList> MultiLevelTextLists { get; }

Property Value

Type	Description
System.Collections.Generic.List<MultiLevelTextList>	A List containing all shape elements.

PageSetup

Gets or sets the page setup information for this section, including headers and footers.

Declaration

public PageSetup PageSetup { get; set; }

Property Value

Type	Description
PageSetup

Paragraphs

Gets a list of all Paragraph elements contained within this document section.

Declaration

public List<Paragraph> Paragraphs { get; }

Property Value

Type	Description
System.Collections.Generic.List<Paragraph>	A List containing all paragraph elements.

RightMargin

Right margin of document section in mm.

Declaration

public double RightMargin { get; }

Property Value

Type	Description
System.Double

TopMargin

Declaration

public double TopMargin { get; }

Property Value

Type	Description
System.Double

Width

Width of document section in mm.

Declaration

public double Width { get; }

Property Value

Type	Description
System.Double

Methods

AddImage(AnyBitmap)

Adds an image to this TableCell from an IronSoftware.Drawing.AnyBitmap object.

Declaration

public ImageContent AddImage(AnyBitmap anyBitmap)

Parameters

Type	Name	Description
IronSoftware.Drawing.AnyBitmap	anyBitmap

Returns

Type	Description
ImageContent

AddImage(ImageContent)

Adds a new Image object to the section.

Declaration

public ImageContent AddImage(ImageContent imageContent)

Parameters

Type	Name	Description
ImageContent	imageContent	The Image object to be added.

Returns

Type	Description
ImageContent

AddImage(Stream)

Adds an image to the to the section.

Declaration

public ImageContent AddImage(Stream imageStream)

Parameters

Type	Name	Description
System.IO.Stream	imageStream	The stream image to be loaded.

Returns

Type	Description
ImageContent	The added Image.

AddImage(String)

Adds an image to the to the section.

Declaration

public ImageContent AddImage(string imagePath)

Parameters

Type	Name	Description
System.String	imagePath	The physical path of Image to be loaded.

Returns

Type	Description
ImageContent	The added Image.

AddMultiLevelTextList(MultiLevelTextList)

Adds a new MultiLevelTextList object to the section.

Declaration

public MultiLevelTextList AddMultiLevelTextList(MultiLevelTextList multiLevelTextList)

Parameters

Type	Name	Description
MultiLevelTextList	multiLevelTextList	The multi-level text list object to be added.

Returns

Type	Description
MultiLevelTextList

AddParagraph(Paragraph)

Adds a new Paragraph object to the section.

Declaration

public Paragraph AddParagraph(Paragraph paragraph)

Parameters

Type	Name	Description
Paragraph	paragraph	The Paragraph object to be added.

Returns

Type	Description
Paragraph

AddShape(ShapeContent)

Adds a new ShapeContent object to the section.

Declaration

public ShapeContent AddShape(ShapeContent shapeContent)

Parameters

Type	Name	Description
ShapeContent	shapeContent	The ShapeContent object to be added.

Returns

Type	Description
ShapeContent

AddTable(Table)

Adds a new Table object to the section.

Declaration

public Table AddTable(Table table)

Parameters

Type	Name	Description
Table	table	The Table object to be added.

Returns

Type	Description
Table

AddText(TextContent)

Adds a TextContent object to the last paragraph of the section.

Declaration

public TextContent AddText(TextContent textContent)

Parameters

Type	Name	Description
TextContent	textContent	The TextContent object to be added.

Returns

Type	Description
TextContent

AddText(String)

Adds text to the last paragraph of the section.

Declaration

public TextContent AddText(string text)

Parameters

Type	Name	Description
System.String	text	The text to be added.

Returns

Type	Description
TextContent

ExtractImages()

Extract all images from this container

Declaration

public List<AnyBitmap> ExtractImages()

Returns

Type	Description
System.Collections.Generic.List<IronSoftware.Drawing.AnyBitmap>	List of images

ExtractShapes()

Extract all shapes from this container

Declaration

public List<IReadOnlyCollection<IPathSegment>> ExtractShapes()

Returns

Type	Description
System.Collections.Generic.List<System.Collections.Generic.IReadOnlyCollection<IronSoftware.IPathSegment>>	List of path segment collections

ExtractText()

Extract all text from the container

Declaration

public string ExtractText()

Returns

Type	Description
System.String	Extracted text

FindText(String)

Find the first text element which contains the specified text

Declaration

public TextContent FindText(string find)

Parameters

Type	Name	Description
System.String	find	Text to find

Returns

Type	Description
TextContent	Text element containing the specified text

Remove(TextContent)

Remove the specified text element

Declaration

public bool Remove(TextContent element)

Parameters

Type	Name	Description
TextContent	element	Text element to remove

Returns

Type	Description
System.Boolean	True if the element was found and removed, False otherwise

ReplaceText(String, String)

Replace all instances of the specified text

Declaration

public void ReplaceText(string find, string replace)

Parameters

Type	Name	Description
System.String	find	Text to replace
System.String	replace	Replacement text

Implements

IronSoftware.Abstractions.IDocumentElement

IronSoftware.IDocumentObject

System.ICloneable

IElementContainer

ITextContainer

IDrawContainer