Interface IFindReplaceControlHandler
Defines the interface that allows working with the find and replace control.
public interface IFindReplaceControlHandlerProperties
- CanFindInAllOpenDocuments
Get or sets whether 'All Open Documents' find scope is available.
- CanFindInCurrentDocument
Get or sets whether 'Current Document' find scope is available.
- CanFindInCurrentProject
Get or sets whether 'Current Project' find scope is available.
- CanFindInSelectionOnly
Get or sets whether 'Current Project' find scope is available.
- CanFindNext
Gets whether the user can perform 'Find Next' action. Returns
trueif FindToolBar and 'Find Next' button are visible.
- CanFindPrevious
Gets whether the user can perform 'Find Previous' action. Returns
trueif FindToolBar and 'Find Previous' button are visible.
- CanMatchCase
Gets whether the user can perform 'Match Case' action. Returns
trueif OptionsToolBar and 'Match Case' button are visible.
- CanMatchWholeWord
Gets whether the user can perform 'Match Whole Word' action. Returns
trueif OptionsToolBar and 'Match Whole Word' button are visible.
- CanReplace
Gets whether the user can perform 'Replace' action. Returns
trueif ReplaceToolBar and 'Replace' button are visible.
- CanReplaceAll
Gets whether the user can perform 'Replace All' action. Returns
trueif ReplaceToolBar and 'Replace All' button are visible.
- CanUseRegularExpressions
Gets whether the user can perform 'Use Regular Expressions' action. Returns
trueif OptionsToolBar and 'Use Regular Expressions' button are visible.
- CloseButtonVisible
Gets or sets whether 'Close' button is visible.
- FindEditEmptyTextHint
Gets or sets a hint shown in an empty unfocused find text editor.
- IsScopeAllOpenDocuments
Gets whether selected scope is 'All open documents'.
- IsScopeCurrentDocument
Gets whether selected scope is 'Current document'.
- IsScopeCurrentProject
Gets whether selected scope is 'Current project'.
- IsScopeEditEnabled
Gets or sets a value indicating whether the scope edit control is enabled.
- IsScopeSelectionOnly
Gets whether selected scope is 'Selection only'.
- Manager
Gets or sets FindReplaceControl.IFindReplaceConnect instance.
- OptionFindTextAtCursor
Gets or sets 'Find Text At Cursor' option.
- OptionHiddenText
Gets or sets 'Hidden Text' option.
- OptionMatchCase
Gets or sets 'Match Case' option.
- OptionMatchCaseEnabled
Gets or sets whether 'Match Case' option is enabled.
- OptionMatchWholeWord
Gets or sets 'Match Whole Word' option.
- OptionMatchWholeWordEnabled
Gets or sets whether 'Match Whole Word' option is enabled.
- OptionPromptOnReplace
Gets or sets 'Prompt On Replace' option.
- OptionSearchUp
Gets or sets 'Search Up' option.
- OptionUseRegularExpressions
Gets or sets 'Use Regular Expressions' option.
- OptionUseRegularExpressionsEnabled
Gets or sets whether 'Use Regular Expressions' option is enabled.
- OptionUseRegularExpressionsVisible
Gets or sets whether 'Use Regular Expressions' option is visible.
- OptionsVisible
Gets or sets whether OptionsToolBar is visible.
- ReplaceEditEmptyTextHint
Gets or sets a hint shown in an empty unfocused replace text editor.
- ReplaceList
Represents the replace history.
- ReplaceVisible
Gets or sets whether ReplaceToolBar is visible.
- Scope
Gets search scope as FindReplaceControl.SearchScope.
- SearchList
Represents the search history.
- ShowErrorBorder
Gets or sets whether to show error border around find text editor.
- TextBoxWidth
Gets or sets width of FindEdit and ReplaceEdit controls.
- TextToFind
Gets or sets the text to find in the search operation.
- TextToReplace
Gets or sets the text to replace in the replace operation.
- ToggleReplaceVisible
Gets or sets whether toggle replace options button is visible.
- WantKeys
Gets or sets whether keys specified in KnownShortcuts.FindReplaceControlKeys are automatically handled.
Methods
- SelectAllTextInFindEditor()
Selects all the text in the find editor control.
- ToggleHiddenText()
Toggles searching through hidden text on/off.
- ToggleMatchCase()
Toggles case sensitive searching on/off.
- ToggleRegularExpressions()
Toggles using regular expressions on/off.
- ToggleSearchUp()
Toggles searching direction towards/backwards.
- ToggleWholeWord()
Toggles searching for whole words on/off.
Events
- ClickClose
Occurs when 'Close' button is clicked.
- ClickFindNext
Occurs when 'Find Next' button is clicked.
- ClickFindPrevious
Occurs when 'Find Previous' button is clicked.
- ClickReplace
Occurs when 'Replace' button is clicked.
- ClickReplaceAll
Occurs when 'Replace All' button is clicked.
- OptionMatchCaseChanged
Occurs when option 'Match Case' is changed.
- OptionMatchWholeWordChanged
Occurs when option 'Match Whole Word' is changed.
- OptionUseRegularExpressionsChanged
Occurs when option 'Use Regular Expressions' is changed.