Table of Contents

Class Popup

Namespace
PluginUI
Assembly
PluginUI.dll

Element shown above the main tree, inside the host window (menus, drop-down lists, color pickers, tooltips, dialogs). Show it with ShowPopup(Popup).

public class Popup : ContentPanel
Inheritance
Popup
Derived
Inherited Members

Properties

Anchor

Anchor rectangle in host DIPs.

public Rect Anchor { get; set; }

Property Value

Rect

CapturesKeyboard

Receives keyboard events before the focused element (menus, lists).

public bool CapturesKeyboard { get; set; }

Property Value

bool

CenterOnAnchor

Centers the popup horizontally on the anchor for Above / Below.

public bool CenterOnAnchor { get; set; }

Property Value

bool

ConsumesOutsideClick

A click outside that closes the popup is not passed to the element below.

public bool ConsumesOutsideClick { get; set; }

Property Value

bool

IsLightDismiss

Closes when the user clicks outside it.

public bool IsLightDismiss { get; set; }

Property Value

bool

IsModal

Dims the host and blocks input to the rest of the UI.

public bool IsModal { get; set; }

Property Value

bool

IsOpen

true while shown.

public bool IsOpen { get; }

Property Value

bool

MinPopupWidth

Minimum width (e.g. the width of the drop-down that opened it).

public float MinPopupWidth { get; set; }

Property Value

float

Placement

Placement relative to Anchor.

public PopupPlacement Placement { get; set; }

Property Value

PopupPlacement

Methods

Close()

Closes the popup.

public void Close()

OnClosed()

Called after the popup closed (raises Closed).

protected virtual void OnClosed()

OnKeyDown(KeyEventArgs)

Keyboard routed to the popup when CapturesKeyboard is set; Escape closes by default.

protected override void OnKeyDown(KeyEventArgs e)

Parameters

e KeyEventArgs

Events

Closed

Raised after the popup closed.

public event Action<Popup>? Closed

Event Type

Action<Popup>