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

SearchOverlayPane Class

Namespace:
ActiproSoftware.Windows.Controls.SyntaxEditor.Primitives
Assembly:
ActiproSoftware.SyntaxEditor.Wpf.dll

Represents an IOverlayPane implementation that can be used to perform searching within an editor.

public class SearchOverlayPane : SearchViewBase, IOverlayPane, IKeyedObject
Inheritance:
object Visual UIElement FrameworkElement Control SearchViewBase object
Implements:
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.

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.

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.

VisualElement

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

public UIElement VisualElement { get; }

Property Value

UIElement:

The UIElement 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()

ApplyStringResources()

Updates the UI strings based on the string resources.

public void ApplyStringResources()

Close()

Closes the pane.

public void Close()

OnClosed()

Occurs when the pane is closed.

protected virtual void OnClosed()

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()

OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)

Reports that the IsKeyboardFocusWithin property changed.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)
Parameter Type Description
e DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs that contains the event data.

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.

OnSearchScopeChanged()

Occurs when the search scope has changed.

protected override void OnSearchScopeChanged()

Events

Closed

Occurs when the pane is closed.

public event EventHandler Closed

Event Type

EventHandler

Fields

ControlKeyDownOpacityProperty

Identifies the ControlKeyDownOpacity dependency property. This field is read-only.

public static readonly DependencyProperty ControlKeyDownOpacityProperty

Inherited Members