Interface ITextContentElement

Represents an element with text content that can be searched, replaced, and converted to a string.

Namespace: IronWord.Models.Abstract.Interfaces

Assembly: IronWord.dll

Syntax

public interface ITextContentElement

ITextContentElement is the contract you work through when a piece of document text needs to be read, searched, restyled, or rewritten on its own. It represents a single styled run of text and exposes the operations that act on that run, so editing code can treat any text element the same way. It differs from the container contracts: a text container holds and arranges text, while a text content element is the styled text itself.

You receive one from the concrete implementors TextContent and Text. Holding either gives you an ITextContentElement, which a search-and-edit method can accept without depending on the exact type.

The two properties are Text, the readable and writable string content, and Style, the read-only TextStyle applied to it. The Find method searches the content with optional RegexOptions, whole-word, and case-sensitive flags and returns a List<int> of match positions. Replace performs the substitution with the same options and returns the updated ITextContentElement, and ToString returns the plain text.

ITextContentElement element = textContent;
element.Replace("draft", "final");
string body = element.Text;

The edit text how-to and the replace words how-to cover searching and rewriting content.

Properties

Style

Gets or sets the style of the text content.

Declaration

TextStyle Style { get; }

Property Value

Type	Description
TextStyle

Text

Gets or sets the text content.

Declaration

string Text { get; set; }

Property Value

Type	Description
System.String

Methods

Find(String, Nullable<RegexOptions>, Boolean, Boolean)

Finds the indices of the specified search text within the text content.

Declaration

List<int> Find(string searchText, Nullable<RegexOptions> regexOption = null, bool wholeWordOnly = false, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	searchText	The text to search for.
System.Nullable<System.Text.RegularExpressions.RegexOptions>	regexOption	Optional. The regular expression options.
System.Boolean	wholeWordOnly	Optional. Indicates whether to match the whole word only.
System.Boolean	caseSensitive	Optional. Indicates whether the search is case-sensitive.

Returns

Type	Description
System.Collections.Generic.List<System.Int32>	A list of indices where the search text is found.

Replace(String, String, Nullable<RegexOptions>, Boolean, Boolean)

Replaces occurrences of the specified search text with the specified replacement text within the text content.

Declaration

ITextContentElement Replace(string searchText, string replaceText, Nullable<RegexOptions> regexOption = null, bool wholeWordOnly = false, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	searchText	The text to search for.
System.String	replaceText	The text to replace occurrences of the search text.
System.Nullable<System.Text.RegularExpressions.RegexOptions>	regexOption	Optional. The regular expression options.
System.Boolean	wholeWordOnly	Optional. Indicates whether to match the whole word only.
System.Boolean	caseSensitive	Optional. Indicates whether the search is case-sensitive.

Returns

Type	Description
ITextContentElement

ToString()

Converts the text content element to its string representation.

Declaration

string ToString()

Returns

Type	Description
System.String	A string representation of the text content element.