Find Method
- Namespace
TXTextControl.WPF
- Package
TXTextControl.asTextControl. WPF. SDK TXTextControl.from the private NuGet feed or Text Control Offline PackagesWPF. dll
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();Public Sub 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);Public Function Find(text As String) As Integer| Parameter | Description |
|---|---|
| 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);Public Function Find(text As String, start As Integer, options As FindOptions) As Integer| Parameter | Description |
|---|---|
| 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}.");
}Dim position As Integer = textControl.Find("Quarterly results")
If position >= 0 Then
Console.WriteLine($"Found at position {position}.")
End If