TX Text Control .NET for WPF

Find Method

Method|Introduced in 16.0
Namespace
TXTextControl.WPF
Package
TXTextControl.TextControl.WPF.SDK as TXTextControl.WPF.dll from the private NuGet feed or Text Control Offline Packages

Description

Finds a text string in the text part with the input focus. This can be the main text, a text frame or a header or footer.

Syntax

Find()

Opens the built-in Find dialog box to search for a text string in the text part with the input focus. This can be the main text, a text frame or a header or footer.

public void Find();

Find(string)

Searches for the specified text string in the text part with the input focus. This can be the main text, a text frame or a header or footer. The search starts at the beginning of the text.

public int Find(string text);
ParameterDescription
text

Specifies the text to search for.

Find(string, int, FindOptions)

Searches for the specified text string in the text part with the input focus. This can be the main text, a text frame or a header or footer. The search is done with the specified find options and starts at the specified position.

public int Find(string text, int start, FindOptions options);
ParameterDescription
text

Specifies the text to search for.

start

Specifies the text position where the search starts, beginning with 0. If this value is -1, the search begins at the current text input position.

options

Specifies search options. It can be a combination of the FindOptions values.

Return Value

If the text searched for is found, the method returns the index (zero-based) of the first character of the search string. If the specified text is not found the method returns -1.

Examples

The following example searches for text and handles the returned position.

int position = textControl.Find("Quarterly results");
if (position >= 0)
{
    Console.WriteLine($"Found at position {position}.");
}