Class FindReplaceControl
Implements main control of the Find and Replace dialogs.
[ControlCategory("MenusAndToolbars")]
public class FindReplaceControl : ToolBarSet, IBaseObject, IDisposableObject, ISupportInitialize, IFocusable, ITextProperty, IComponent, IControl, IDisposable, IWin32Window, INotifyDataErrorInfo
- Inheritance
-
FindReplaceControl
- Implements
Remarks
Example of how a FindReplaceControl can look on different platforms:
Constructors
- FindReplaceControl()
Initializes a new instance of the FindReplaceControl class.
Fields
- DefaultFindEditBorderColorDark
Gets or sets default border color of the find text editor. This property contains default value for the light color theme.
- DefaultFindEditBorderColorLight
Gets or sets default border color of the find text editor. This property contains default value for the light color theme.
- DefaultNotFoundBorderDark
Gets or sets default border color of the find text editor in the case when search string is not found. This property contains default value for the dark color theme.
- DefaultNotFoundBorderLight
Gets or sets default border color of the find text editor in the case when search string is not found. This property contains default value for the light color theme.
Properties
- 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.
- CloseButtonVisible
Gets or sets whether 'Close' button is visible.
- FindEditBorder
Gets border of the FindEdit.
- FindEditBorderColor
Gets border color of the find text editor.
- FindToolBar
Gets ToolBar with find buttons.
- IdFindClose
Gets id of the 'Close' button.
- IdFindEdit
Gets id of the 'Find' editor.
- IdFindNext
Gets id of the 'Find Next' button.
- IdFindPrevious
Gets id of the 'Find Previous' button.
- IdMatchCase
Gets id of the 'Match Case' button.
- IdMatchWholeWord
Gets id of the 'Match Whole Word' button.
- IdReplace
Gets id of the 'Replace' button.
- IdReplaceAll
Gets id of the 'Replace All' button.
- IdReplaceEdit
Gets id of the 'Replace' editor.
- IdScopeEdit
Gets id of the 'Scope' editor.
- IdToggleReplaceOptions
Gets id of the 'Toggle Replace Options' button.
- IdUseRegularExpressions
Gets id of the 'Use Regular Expressions' button.
- Manager
Gets or sets FindReplaceControl.IFindReplaceConnect instance.
- NotFoundBorderColor
Gets or sets border color of the find text editor in the case when search string is not found.
- 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.
- 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.
- OptionsToolBar
Gets ToolBar with option buttons.
- ReplaceEdit
Gets ComboBox which allows to specify text to replace.
- ReplaceEditBorder
Gets border of the ReplaceEdit.
- ReplaceToolBar
Gets ToolBar with replace buttons.
- ReplaceVisible
Gets or sets whether ReplaceToolBar is visible.
- ScopeItemAllOpenDocuments
Gets 'All Open Documents' item in the ScopeEdit.
- ScopeItemCurrentDocument
Gets 'Current Document' item in the ScopeEdit.
- ScopeItemCurrentProject
Gets 'Current Project' item in the ScopeEdit.
- ShowErrorBorder
Gets or sets whether to show error border around find text editor.
- TextBoxWidth
Gets or sets width of FindEdit and ReplaceEdit controls.
- WantKeys
Gets or sets whether keys specified in KnownShortcuts.FindReplaceControlKeys are automatically handled.
Methods
- CreateInsideDialog(bool)
Creates FindReplaceControl inside DialogWindow.
- CreateLogger()
Creates FindReplaceControl.IFindReplaceConnect instance which logs all method calls.
- HandleKeys(KeyEventArgs)
Handles keys specified in KnownShortcuts.FindReplaceControlKeys.
- OnKeyDown(KeyEventArgs)
Called when the KeyDown event is raised.
- 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.