In This Article

IOverlayPane Interface

Provides the base requirements for an overlay pane that can appear over an IEditorView.

public interface IOverlayPane : IKeyedObject

Properties

CloseCommand

Gets the ICommand that closes the pane.

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.

double ControlKeyDownOpacity { get; }

Property Value

double:

The opacity of the pane while the control key is pressed. A recommended 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.

OverlayPaneInstanceKind InstanceKind { get; }

Property Value

OverlayPaneInstanceKind:

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

VisualElement

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

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.

void Activate()

Close()

Closes the pane.

void Close()

Events

Closed

Occurs when the pane is closed.

event EventHandler Closed

Event Type

EventHandler

Inherited Members