RichTextBox::Find Method (String^, RichTextBoxFinds)
Searches the text in a RichTextBox control for a string with specific options applied to the search.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Parameters
- str
-
Type:
System::String^
The text to locate in the control.
- options
-
Type:
System.Windows.Forms::RichTextBoxFinds
A bitwise combination of the RichTextBoxFinds values.
The Find method searches for the text specified in the str parameter and returns the location of the first character within the control. If the property returns a negative value, the text string being searched for was not found within the contents of the control. You can use this method to create search functionality that can be provided to the user of the control. You can also use this method to search for text to be replaced with a specific format. For example, if the user entered dates into the control, you can use the Find method to search for all dates in the document and replace them with the appropriate format before using the SaveFile method of the control.
With this version of the Find method, you can specify options that enable you to expand or narrow your search. You can specify options that enable you to match the casing of the search word or to search for entire words instead of partial words. By specifying the RichTextBoxFinds.Reverse enumeration in the options parameter, you can search for text from the bottom of the document to the top instead of the default top to bottom search method.
Note |
|---|
The Find methods that accept a string as a parameter cannot find text that is contained on more than one line of text within the RichTextBox. Performing such a search will return a value of negative one (-1). |
The following code example searches the entire contents of a RichTextBox for the first instance of a search string passed into the text parameter of the method. If the search string is found in the RichTextBox, the method returns a value of true and highlights the text; otherwise, it returns false. The example also specifies options in the search to match the case of the specified search string. The example requires that this method is placed in the class of a Form that contains a RichTextBox named richTextBox1.
public: bool FindMyText( String^ text ) { // Initialize the return value to false by default. bool returnValue = false; // Ensure a search string has been specified. if ( text->Length > 0 ) { // Obtain the location of the search string in richTextBox1. int indexToText = richTextBox1->Find( text, RichTextBoxFinds::MatchCase ); // Determine if the text was found in richTextBox1. if ( indexToText >= 0 ) { returnValue = true; } } return returnValue; }
Available since 1.1
