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

Properties

Style

Gets or sets the style of the text content.

Declaration

TextStyle Style { get; set; }

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.