Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

SearchOverlayPane Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.SyntaxEditor.Primitives
Assembly:
ActiproSoftware.SyntaxEditor.WinForms.dll

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 SearchOverlayPane class.

public SearchOverlayPane(IEditorView view)
Parameter Type Description
view IEditorView

The view that owns the pane.

Properties

CloseCommand

Gets the ICommand that closes the pane.

public ICommand CloseCommand { get; }

Property Value

ICommand:

The ICommand that closes the pane.

ControlKeyDownOpacity

Gets or sets the opacity of the pane while the control key is pressed.

public double ControlKeyDownOpacity { get; set; }

Property Value

double:

The opacity of the pane while the control key is pressed. The default value is 0.25.

Remarks

Set the value to 1.0 to prevent opacity changes when the control key is pressed.

FindAllButton

Gets the find all button button.

protected override CommandButton FindAllButton { get; }

Property Value

CommandButton:

The find all button button.

InstanceKind

Gets the OverlayPaneInstanceKind that indicates how many instances of the pane are permitted across all views.

public virtual OverlayPaneInstanceKind InstanceKind { get; }

Property Value

OverlayPaneInstanceKind:

The OverlayPaneInstanceKind that indicates how many instances of the pane are permitted across all views.

Key

Gets the string-based key that identifies the object.

public string Key { get; }

Property Value

string:

The string-based key that identifies the object.

MatchCaseButton

Gets the match case button.

protected override CommandButton MatchCaseButton { get; }

Property Value

CommandButton:

The match case button.

MatchWholeWordButton

Gets the match whole word button.

protected override CommandButton MatchWholeWordButton { get; }

Property Value

CommandButton:

The match whole word button.

ModeToggleButton

Gets the mode toggle button.

protected override CommandButton ModeToggleButton { get; }

Property Value

CommandButton:

The mode toggle button.

ReplaceAllButton

Gets the replace all button.

protected override CommandButton ReplaceAllButton { get; }

Property Value

CommandButton:

The replace all button.

ReplaceNextButton

Gets the replace next button.

protected override CommandButton ReplaceNextButton { get; }

Property Value

CommandButton:

The replace next button.

SearchScopeComboBox

Gets the search scope combobox.

protected override ComboBox SearchScopeComboBox { get; }

Property Value

ComboBox:

The search scope combobox.

SearchUpButton

Gets the search up button.

protected override CommandButton SearchUpButton { get; }

Property Value

CommandButton:

The search up button.

TargetView

Gets the target IEditorView in which the searching will occur.

public override IEditorView TargetView { get; }

Property Value

IEditorView:

The target IEditorView in which the searching will occur.

UseRegularExpressionsButton

Gets the use regular expressions button.

protected override CommandButton UseRegularExpressionsButton { get; }

Property Value

CommandButton:

The use regular expressions button.

VisualElement

Gets the Control that is used to visually render the pane.

public Control VisualElement { get; }

Property Value

Control:

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:

true if the specified key is a regular input key; otherwise, false.

MeasureOverride(Graphics, Size)

Measures the size required for the element and its child elements.

protected override Size MeasureOverride(Graphics g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics to use for measurement.
availableSize Size

The available size.

Returns

Size:

The desired size.

OnClosed()

Occurs when the pane is closed.

protected virtual void OnClosed()

OnEnter(EventArgs)

Occurs when focus enters the control.

protected override void OnEnter(EventArgs e)
Parameter Type Description
e EventArgs

The EventArgs that contains data related to the event.

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)

Occurs when a key is pressed.

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

A PaintEventArgs that contains 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

The message.
keyData Keys

The key data to examine.

Returns

bool:

true if the specified key is processed; otherwise, false.

ProcessDialogKey(Keys)

Processes a dialog key.

protected override bool ProcessDialogKey(Keys keyData)
Parameter Type Description
keyData Keys

The key data to examine.

Returns

bool:

true if the specified key is processed; otherwise, false.

RaiseCanExecuteChangedForCommands()

Raise the can-execute changed events for commands.

protected override void RaiseCanExecuteChangedForCommands()

Events

Closed

Occurs when the pane is closed.

public event EventHandler Closed

Event Type

EventHandler

Inherited Members