SearchOverlayPane Class
Represents an IOverlayPane implementation that can be used to perform searching within an editor.
public class SearchOverlayPane : SearchViewBase, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IOverlayPane, IKeyedObject- Inheritance:
- object MarshalByRefObject Component Control ScrollableControl UIControl SearchViewBase object
- Implements:
- IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IOverlayPane IKeyedObject
Constructors
SearchOverlayPane(IEditorView)
Initializes an instance of the class.
public SearchOverlayPane(IEditorView view)| Parameter | Type | Description |
|---|---|---|
| view | IEditorView | The view that owns the pane. |
Properties
CloseCommand
The ICommand that closes the pane.
FindAllButton
The find all button.
InstanceKind
The OverlayPaneInstanceKind that indicates how many instances of the pane are permitted across all views.
public virtual OverlayPaneInstanceKind InstanceKind { get; }Property Value
- OverlayPaneInstanceKind:
The default value is Single.
Key
The string-based key that identifies the object.
MatchCaseButton
The match case button.
MatchWholeWordButton
The match whole word button.
ModeToggleButton
The mode toggle button.
ReplaceAllButton
The replace all button.
ReplaceNextButton
The replace next button.
SearchScopeComboBox
The search scope combobox.
SearchUpButton
The search up button.
TargetView
The target IEditorView in which the searching will occur.
UseRegularExpressionsButton
The use regular expressions button.
VisualElement
The Control that is used to visually render the pane.
Methods
Activate()
Activates the pane, called when the pane is already open to perform tasks like moving focus into itself.
public void Activate()ArrangeChildren()
Arranges the children.
protected override void ArrangeChildren()Close()
Closes the pane.
public void Close()DpiScaleChanged(SizeF)
Called when the DPI-based scale factor of the element changes.
public override void DpiScaleChanged(SizeF scaleFactor)| Parameter | Type | Description |
|---|---|---|
| scaleFactor | SizeF | The new scale factor where Width is applied to the x-axis, and Height is applied to the y-axis. |
See Also
InitializeChildren()
Initializes the children.
protected override void InitializeChildren()IsInputKey(Keys)
Determines whether the specified key is a regular input key or a special key that requires preprocessing.
protected override bool IsInputKey(Keys keyData)| Parameter | Type | Description |
|---|---|---|
| keyData | Keys | One of the Keys values. |
Returns
- bool:
trueif the specified key is a regular input key; otherwise,false.
MeasureOverride(Graphics?, Size)
Measures the size in layout required for child elements and determines a size for the element itself.
protected override Size MeasureOverride(Graphics? g, Size availableSize)| Parameter | Type | Description |
|---|---|---|
| g | Graphics | The Graphics object to use for measurement. |
| availableSize | Size | The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available. |
Returns
- Size:
The size that this element determines it needs during layout, based on its calculations of child element sizes.
Remarks
Element authors should override this method, call Measure(Graphics?, Size) on each visible child element and determine the total size required.
OnClosed()
Occurs when the pane is closed.
protected virtual void OnClosed()OnEnter(EventArgs)
Raises the Enter event.
protected override void OnEnter(EventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | An EventArgs that contains the event data. |
OnFindSearchOptionsChanged()
Occurs when a search option is changed that may affect find results, such as those used for search result highlighting.
protected override void OnFindSearchOptionsChanged()OnKeyDown(KeyEventArgs)
Raises the KeyDown event.
protected override void OnKeyDown(KeyEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | KeyEventArgs | A KeyEventArgs that contains the event data. |
OnRender(PaintEventArgs)
Renders the element.
protected override void OnRender(PaintEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | PaintEventArgs | The event data. |
OnSearchScopeChanged()
Occurs when the search scope has changed.
protected override void OnSearchScopeChanged()ProcessCmdKey(ref Message, Keys)
Processes a command key.
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)| Parameter | Type | Description |
|---|---|---|
| msg | Message | A Message, passed by reference, that represents the window message to process. |
| keyData | Keys | One of the Keys values that represents the key to process. |
Returns
- bool:
trueif the character was processed by the control; otherwise,false.
ProcessDialogKey(Keys)
Processes a dialog key.
protected override bool ProcessDialogKey(Keys keyData)| Parameter | Type | Description |
|---|---|---|
| keyData | Keys | One of the Keys values that represents the key to process. |
Returns
- bool:
trueif the key was processed by the control; otherwise,false.
RaiseCanExecuteChangedForCommands()
Raise the can-execute changed events for commands.
protected override void RaiseCanExecuteChangedForCommands()Events
Closed
Occurs when the pane is closed.
Inherited Members
- SearchViewBase.FocusFindWhatTextBox()
- SearchViewBase.OnFindWhatTextBoxKeyDown(KeyEventArgs)
- SearchViewBase.OnReplaceWithTextBoxKeyDown(KeyEventArgs)
- SearchViewBase.OnSearching(SearchOperationType)
- SearchViewBase.OnSearchOptionsChanged()
- SearchViewBase.OnCanToggleReplacePropertyChanged(bool, bool)
- SearchViewBase.OnIsFindAllButtonVisiblePropertyChanged(bool, bool)
- SearchViewBase.OnIsOptionsPanelExpandedPropertyChanged(bool, bool)
- SearchViewBase.OnIsReplaceVisiblePropertyChanged(bool, bool)
- SearchViewBase.OnPaddingChanged(EventArgs)
- SearchViewBase.OnPropertyChanged(string)
- SearchViewBase.OnPropertyChanged(PropertyChangedEventArgs)
- SearchViewBase.OnResize(EventArgs)
- SearchViewBase.OnSearchOptionsPropertyChanged(IEditorSearchOptions, IEditorSearchOptions)
- SearchViewBase.OnSearchOptionsPropertyChanged(PropertyChangedEventArgs)
- SearchViewBase.OnSearchPatternProviderFactoryPropertyChanged(ISearchPatternProviderFactory, ISearchPatternProviderFactory)
- SearchViewBase.OnUseRegularExpressionsPropertyChanged(bool, bool)
- SearchViewBase.SetProperty<T>(ref T, T, string)
- SearchViewBase.FindAllCommand
- SearchViewBase.FindNextCommand
- SearchViewBase.FindWhatTextBox
- SearchViewBase.ReplaceAllCommand
- SearchViewBase.ReplaceNextCommand
- SearchViewBase.ReplaceWithTextBox
- SearchViewBase.SearchPatternProviders
- SearchViewBase.ToggleOptionsPanelExpandedCommand
- SearchViewBase.CanToggleReplace
- SearchViewBase.HasNoSearchResults
- SearchViewBase.IsFindAllButtonVisible
- SearchViewBase.IsOptionsPanelExpanded
- SearchViewBase.IsReplaceVisible
- SearchViewBase.SearchOptions
- SearchViewBase.SearchPatternProviderFactory
- SearchViewBase.ToggleMatchCaseCommand
- SearchViewBase.ToggleMatchWholeWordCommand
- SearchViewBase.ToggleModeCommand
- SearchViewBase.ToggleSearchUpCommand
- SearchViewBase.ToggleUseRegularExpressionsCommand
- SearchViewBase.UseRegularExpressions
- SearchViewBase.SearchOptionsChanged
- SearchViewBase.PropertyChanged
- UIControl.Dispose(bool)
- UIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIControl.AddPendingScrollOperation(Rectangle, int, int)
- UIControl.AddToInvalidatedRegion()
- UIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.Arrange(Rectangle)
- UIControl.ArrangeOverride(Size)
- UIControl.ContainsLocation(Point)
- UIControl.CreateChildren()
- UIControl.GetCursor(Point)
- UIControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIControl.InvalidateArrange()
- UIControl.InvalidateMeasure()
- UIControl.Measure(Graphics, Size)
- UIControl.OnClick(EventArgs)
- UIControl.OnDoubleClick(EventArgs)
- UIControl.OnDpiChangedAfterParent(EventArgs)
- UIControl.OnHandleCreated(EventArgs)
- UIControl.OnLayout(LayoutEventArgs)
- UIControl.OnLocationChanged(EventArgs)
- UIControl.OnMouseCaptureChanged(EventArgs)
- UIControl.OnMouseDown(MouseEventArgs)
- UIControl.OnMouseEnter(EventArgs)
- UIControl.OnMouseHover(EventArgs)
- UIControl.OnMouseLeave(EventArgs)
- UIControl.OnMouseMove(MouseEventArgs)
- UIControl.OnMouseUp(MouseEventArgs)
- UIControl.OnMouseWheel(MouseEventArgs)
- UIControl.OnPaint(PaintEventArgs)
- UIControl.OnPaintBackground(PaintEventArgs)
- UIControl.OnParentChanged()
- UIControl.OnParentChanged(EventArgs)
- UIControl.OnRenderChildElements(PaintEventArgs)
- UIControl.OnRightToLeftChanged(EventArgs)
- UIControl.OnVisibleChanged(EventArgs)
- UIControl.Render(PaintEventArgs)
- UIControl.ResetDoubleBufferCanvas(bool)
- UIControl.ResumePainting()
- UIControl.SuspendPainting()
- UIControl.TransformToAncestor(IUIElement)
- UIControl.TransformToDescendant(IUIElement)
- UIControl.UpdateCursor()
- UIControl.UpdateCursor(Point)
- UIControl.UpdateLayout()
- UIControl.ActualHeight
- UIControl.ActualWidth
- UIControl.BackColor
- UIControl.BackgroundImage
- UIControl.CaptureMouseWhenPressed
- UIControl.ClipBounds
- UIControl.DesiredSize
- UIControl.DpiScaleFactor
- UIControl.Font
- UIControl.ForeColor
- UIControl.IsArrangeValid
- UIControl.IsMeasureValid
- UIControl.IsPaintValid
- UIControl.IsRightToLeft
- UIControl.LastMouseUpButton
- UIControl.PaintingSuspended
- UIControl.UseControlGraphicsForMeasure
- UIControl.UseExtendedDoubleBuffering
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()