Class WordDocument

Inheritance
System.Object
WordDocument
Implements
IronSoftware.Abstractions.IDocumentLayoutContainer<ContentElementCollection, ContentElement>
IronSoftware.Abstractions.IDocumentWithExtractableText
IronSoftware.IJsonSerializable
IronSoftware.Abstractions.IPageContainer
IronSoftware.Abstractions.IElementContainer<ContentElementCollection, ContentElement>
Namespace: IronWord
Assembly: IronWord.dll
Syntax
public class WordDocument : Object, IDocumentLayoutContainer<ContentElementCollection, ContentElement>, IDocumentWithExtractableText, IJsonSerializable, IPageContainer, IElementContainer<ContentElementCollection, ContentElement>, IElementContainer, ITextContainer, IDrawContainer

Constructors

WordDocument()

Declaration
public WordDocument()

WordDocument(ContentElement[])

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

WordDocument(Byte[])

Declaration
public WordDocument(byte[] bytes)
Parameters
Type Name Description
System.Byte[] bytes

WordDocument(String)

Declaration
public WordDocument(string filePath)
Parameters
Type Name Description
System.String filePath

Properties

Children

Declaration
public ContentElementCollection Children { get; set; }
Property Value
Type Description
ContentElementCollection

Height

Declaration
public double Height { get; }
Property Value
Type Description
System.Double

MarginBottom

Declaration
public double MarginBottom { get; }
Property Value
Type Description
System.Double

MarginLeft

Declaration
public double MarginLeft { get; }
Property Value
Type Description
System.Double

MarginRight

Declaration
public double MarginRight { get; }
Property Value
Type Description
System.Double

MarginTop

Declaration
public double MarginTop { get; }
Property Value
Type Description
System.Double

MultiLevelTextLists

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

PageCount

Declaration
public int PageCount { get; }
Property Value
Type Description
System.Int32

PageIndex

Declaration
public int PageIndex { get; }
Property Value
Type Description
System.Int32

PageSetup

Declaration
public PageSetup PageSetup { get; }
Property Value
Type Description
PageSetup

Paragraphs

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

Tables

Declaration
public List<Table> Tables { get; }
Property Value
Type Description
System.Collections.Generic.List<Table>

Texts

Declaration
public List<TextContent> Texts { get; }
Property Value
Type Description
System.Collections.Generic.List<TextContent>

Width

Declaration
public double Width { get; }
Property Value
Type Description
System.Double

Methods

AddChild(ContentElement[])

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

AddImage(AnyBitmap)

Declaration
public ImageContent AddImage(AnyBitmap anyBitmap)
Parameters
Type Name Description
IronSoftware.Drawing.AnyBitmap anyBitmap
Returns
Type Description
ImageContent

AddImage(ImageContent)

Declaration
public ImageContent AddImage(ImageContent imageContent)
Parameters
Type Name Description
ImageContent imageContent
Returns
Type Description
ImageContent

AddImage(Stream)

Declaration
public ImageContent AddImage(Stream imageStream)
Parameters
Type Name Description
System.IO.Stream imageStream
Returns
Type Description
ImageContent

AddImage(String)

Declaration
public ImageContent AddImage(string imagePath)
Parameters
Type Name Description
System.String imagePath
Returns
Type Description
ImageContent

AddMultiLevelTextList(MultiLevelTextList)

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

AddParagraph(Paragraph)

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

AddSection()

Declaration
public void AddSection()

AddSection(DocumentSection)

Declaration
public void AddSection(DocumentSection documentSection)
Parameters
Type Name Description
DocumentSection documentSection

AddShape(ShapeContent)

Declaration
public ShapeContent AddShape(ShapeContent shapeContent)
Parameters
Type Name Description
ShapeContent shapeContent
Returns
Type Description
ShapeContent

AddTable(Table)

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

AddText(TextContent)

Declaration
public TextContent AddText(TextContent textContentRun)
Parameters
Type Name Description
TextContent textContentRun
Returns
Type Description
TextContent

AddText(String)

Declaration
public TextContent AddText(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
TextContent

ExtractImages()

Declaration
public List<AnyBitmap> ExtractImages()
Returns
Type Description
System.Collections.Generic.List<IronSoftware.Drawing.AnyBitmap>

ExtractShapes()

Declaration
public List<IReadOnlyCollection<IPathSegment>> ExtractShapes()
Returns
Type Description
System.Collections.Generic.List<System.Collections.Generic.IReadOnlyCollection<IronSoftware.IPathSegment>>

ExtractText()

Declaration
public string ExtractText()
Returns
Type Description
System.String

ExtractTextFromPage(Int32)

Declaration
public string ExtractTextFromPage(int PageIndex)
Parameters
Type Name Description
System.Int32 PageIndex
Returns
Type Description
System.String

ExtractTextFromPages(IEnumerable<Int32>)

Declaration
public string ExtractTextFromPages(IEnumerable<int> PageIndices)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Int32> PageIndices
Returns
Type Description
System.String

FindText(String)

Declaration
public TextContent FindText(string find)
Parameters
Type Name Description
System.String find
Returns
Type Description
TextContent

LogObjectTree()

Declaration
public void LogObjectTree()

Remove(TextContent)

Declaration
public bool Remove(TextContent element)
Parameters
Type Name Description
TextContent element
Returns
Type Description
System.Boolean

ReplaceText(String, String)

Declaration
public void ReplaceText(string find, string replace)
Parameters
Type Name Description
System.String find
System.String replace

Save()

Declaration
public byte[] Save()
Returns
Type Description
System.Byte[]

Save(String)

Declaration
public void Save(string filePath)
Parameters
Type Name Description
System.String filePath

SaveAs(String)

Declaration
public void SaveAs(string filePath)
Parameters
Type Name Description
System.String filePath

ToJson()

Declaration
public string ToJson()
Returns
Type Description
System.String

Implements

IronSoftware.Abstractions.IDocumentLayoutContainer<, >
IronSoftware.Abstractions.IDocumentWithExtractableText
IronSoftware.IJsonSerializable
IronSoftware.Abstractions.IPageContainer
IronSoftware.Abstractions.IElementContainer<, >