Class TextContainer

Represents an object that contains text.

Inheritance
System.Object
ContentElement
ParentElement
TextContainer
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.Abstract
Assembly: IronWord.dll
Syntax
public abstract class TextContainer : ParentElement, ITextContainer

When a document node needs to carry and edit running text in C#, TextContainer supplies that behavior. It is the base for parent nodes whose job is to hold text content, layering text-specific operations on top of the general child management it inherits from ParentElement. A developer reaches its members whenever the task is reading, searching, or rewriting the words inside a container rather than rearranging arbitrary nodes.

A TextContainer is obtained as the base of a concrete text-bearing node built or read from a document, not constructed on its own, since the type is abstract. From there the work is direct: add text, find it, and replace it. The container also satisfies the ITextContainer contract, so code that only needs the text surface can depend on that interface instead of the concrete node.

The everyday members read in plain terms. AddText appends content, accepting either a ready TextContent node or a raw string that the container wraps for you. ExtractText returns the container's text as a single string, handy for inspection or export. FindText locates a TextContent matching a search string, and ReplaceText swaps one substring for another across the container. Remove detaches a specific TextContent, and AddChild is overridden here so added nodes integrate with the text model. Together these cover the common edit-in-place tasks without dropping to the lower-level child API.

using IronWord;
using IronWord.Models;

WordDocument doc = new WordDocument("input.docx");
Paragraph paragraph = doc.Paragraphs[0];
paragraph.ReplaceText("draft", "final");
Console.WriteLine(paragraph.ExtractText());

The edit text how-to changes content in place, the replace words how-to covers find-and-replace, and the extract text how-to reads it back out.

Constructors

TextContainer()

Declaration
protected TextContainer()

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

AddText(TextContent)

Adds a new Run to this paragraph.

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

AddText(String)

Adds a new Text to this paragraph.

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

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.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