Interface ITextContainer

Represents a container for text elements.

Namespace: IronWord.Models.Abstract.Interfaces

Assembly: IronWord.dll

Syntax

public interface ITextContainer

Adding, finding, and replacing words inside a document part runs through ITextContainer, the IronWord contract for text-bearing elements. It lets the same string-handling calls work on a section, a paragraph, or a run, so editing logic stays the same regardless of which element holds the words. It is the text-only counterpart to IDrawContainer, which handles images and shapes instead.

You obtain a text container by holding a concrete element that implements it: DocumentSection, Paragraph, and Run all satisfy ITextContainer. Coding against the interface keeps a find-and-replace routine reusable across those element types and easy to unit test.

The key methods are AddText, which appends a string or a TextContent and returns the created TextContent, ExtractText, which returns the container's text as a string, FindText, which locates a substring and returns the matching TextContent, ReplaceText, which swaps one string for another in place, and Remove, which deletes a TextContent and returns a bool for whether it was found.

ITextContainer container = paragraph;
container.AddText("Quarterly summary");
container.ReplaceText("draft", "final");

The add text how-to covers inserting content and the replace words how-to handles substitutions.

Methods

AddText(TextContent)

Adds a pre-existing Run to the text container.

Declaration

TextContent AddText(TextContent Run)

Parameters

Type	Name	Description
TextContent	Run	The Run to be added.

Returns

Type	Description
TextContent	The added Run.

AddText(String)

Adds a Run with the specified text to the text container.

Declaration

TextContent AddText(string text)

Parameters

Type	Name	Description
System.String	text	The text content of the Run to be added.

Returns

Type	Description
TextContent	The added Run.

ExtractText()

Extract all text from the container

Declaration

string ExtractText()

Returns

Type	Description
System.String	Extracted text

FindText(String)

Find the first text element which contains the specified text

Declaration

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

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

void ReplaceText(string find, string replace)

Parameters

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