ISearch Interface
Definition
Represents properties and methods used to search and replace control's text content.
Syntax
public interface ISearch : ITextSearchProperties
| FirstSearch | When implemented by a class, gets or sets a value indicating whether control launches text search at first. |
| GotoLineDialog | When implemented by a class, gets or sets a dialog prompting for index of the line you need to locate. |
| HighlightSearchResults | When implemented by a class, indicates whether search results are highlighted while the search dialog is open. |
| IncrementalSearchString | When implemented by a class, return text to search if class is in incremental search state; otherwise return empty string. |
| InIncrementalSearch | When implemented by a class, indicates whether control is in incremental search state. |
| SearchDialog | When implemented by a class, gets or sets a dialog box allowing to search for the text or replace it. |
| SearchGlobal | When implemented by a class, gets or sets a value indicating whether search should be global. |
| SearchLen | When implemented by a class, represents length of the last found text. |
| SearchOptions | When implemented by a class, gets or sets a value that defines search and replace options. |
| SearchPos | When implemented by a class, gets or sets a value that represents position of the last found text. |
Methods
| CanFindNext() | When implemented by a class, indicates whether search engine can find next occurrence of the text specified by previous search or it is only first attempt to search. |
| CanFindNextSelected() | When implemented by a class, indicates whether search engine can find next occurrence of the selected text or it is the first attempt to search. |
| CanFindPrevious() | When implemented by a class, indicates whether search engine can find previous occurrence of the text specified to search or it is the first attempt to search. |
| CanFindPreviousSelected() | When implemented by a class, indicates whether search engine can find previous occurrence of the selected text or it is the first attempt to search. |
| CanSearchSelection(out String) | When implemented by a class, returns whether search can be performed inside selection. |
| CycledSearch(String, SearchOptions, Regex, Boolean) | When implemented by a class, performs cycled search. |
| Find(String) | When implemented by a class, searches for given text within the control's contents. |
| Find(String, SearchOptions) | When implemented by a class, searches for given text within the control's contents with specified options. |
| Find(String, SearchOptions, Regex) | When implemented by a class, searches for given text within the control's contents with specified options using specified regular expression. |
| Find(String, SearchOptions, Regex, Boolean, Boolean) | When implemented by a class, searches for all occurrences of given text within the control's contents with specified options using specified regular expression. |
| Find(String, SearchOptions, Regex, IList<IRange>) | When implemented by a class, searches for all occurrences of given text within the control's contents with specified options using specified regular expression. |
| FindNext() | When implemented by a class, searches for the next occurrence of the text specified by previous search. |
| FindNextSelected() | When implemented by a class, searches for the next occurrence of the selected text. |
| FindPrevious() | When implemented by a class, searches for the previous occurrence of the text specified by previous search. |
| FindPreviousSelected() | When implemented by a class, searches for the previous occurrence of the selected text. |
| FinishIncrementalSearch() | When implemented by a class, leaves control from the incremental search state. StartIncrementalSearch() |
| GetTextToSearchAtCursor() | When implemented by a class, returns word at the cursor position. |
| HighlightAll(String, SearchOptions, Regex) | When implemented by a class, highlights all occurrences of specified string in the class text content. |
| IncrementalSearch(String, Boolean) | When implemented by a class, finds given text incrementally. |
| MarkAll(String, SearchOptions, Boolean) | When implemented by a class, marks all occurrences of specified string in the class text content by unnumbered bookmarks and moves to the last occurrence. |
| MarkAll(String, SearchOptions, Regex, Boolean) | When implemented by a class, marks all occurrences of specified string in the class text content by unnumbered bookmarks and moves to the last occurrence. |
| MarkAll(String, Boolean) | When implemented by a class, marks all occurrences of specified string in the class text content by unnumbered bookmarks and moves to the last occurrence. |
| NeedReplaceCurrent(out Match) | When implemented by a class, indicates whether search engine need to replace successfully found and selected text. |
| OnTextFound(String, SearchOptions, Regex, Match, Point, Int32, Boolean, Boolean) | When implemented by a class, occurs when search text is found. |
| Replace(String, String) | When implemented by a class, searches for the first occurrence of given text within the text content and if succeed replaces it by specified string. |
| Replace(String, String, SearchOptions) | When implemented by a class, searches for first occurrence given text within the text content with specified options and if succeed replaces it by specified string. |
| Replace(String, String, SearchOptions, Regex) | When implemented by a class, searches for first occurrence given text within the text content with specified options using specified regular expression and if succeed replaces it by specified string. |
| ReplaceAll(String, String, SearchOptions, out Int32) | When implemented by a class, replaces all occurrences of given text within text content by specified replaceWith string. |
| ReplaceAll(String, String, SearchOptions, Regex, out Int32) | When implemented by a class, replaces all occurrences of given text within class text content by specified replaceWith string. |
| ReplaceAll(String, String, SearchOptions, Regex, out Int32, out Boolean) | When implemented by a class, replaces all occurrences of given text within class text content by specified replaceWith string. |
| ReplaceAll(String, String, out Int32) | When implemented by a class, replaces all occurrences of given text within class text content by specified replaceWith string. |
| ReplaceCurrent(String, SearchOptions, Match) | When implemented by a class, replaces currently selected text. |
| ShowNotFound(String) | When implemented by a class, displays "searched text not found" message box. |
| StartIncrementalSearch() | When implemented by a class, enters control to the incremental search state. FinishIncrementalSearch() |
| StartIncrementalSearch(Boolean) | When implemented by a class, enters control to the incremental search state. FinishIncrementalSearch() |
| UnhighlightAll() | When implemented by a class, unhighlights search results previously highlighted by HighlightAll. |
Events
| TextChanged | When implemented by a class, occurs when the TextEditor text changes. |