Class NoOpUiRegistry

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The UI registry a host that draws nothing hands out: registrations are accepted and discarded, and every query answers false.

public sealed class NoOpUiRegistry : IScopedUiRegistry, IUiRegistry

Inheritance

object

NoOpUiRegistry

Implements

IScopedUiRegistry

IUiRegistry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Instance

The shared instance; this type holds no state.

public static NoOpUiRegistry Instance { get; }

Property Value

NoOpUiRegistry

Methods

AddMarkupPanel(string, object)

public void AddMarkupPanel(string markupPath, object binding)

Parameters

markupPath string

Absolute path to the plugin's panel markup file.

binding object

Object whose properties the markup's {Bindings} resolve against.

AddPanel(PluginPanelDescriptor, string, object)

Registers a window for the plugin's lifetime, with a descriptor giving its id, title and shelf button.

public void AddPanel(PluginPanelDescriptor descriptor, string markupPath, object binding)

Parameters

descriptor PluginPanelDescriptor

How the window is identified and presented.

markupPath string

Absolute path to the plugin's panel markup file.

binding object

Object whose properties the markup's {Bindings} resolve against.

HideClientWindow(PluginClientWindow)

Hides one of the client's own windows. Returns whether the host recognized it.

public bool HideClientWindow(PluginClientWindow window)

Parameters

window PluginClientWindow

Returns

bool

IsClientWindowVisible(PluginClientWindow)

Whether one of the client's own windows is currently visible.

public bool IsClientWindowVisible(PluginClientWindow window)

Parameters

window PluginClientWindow

Returns

bool

RegisterMarkupPanel(string, object)

Registers a window from a markup file and returns a token that removes it again.

public IDisposable RegisterMarkupPanel(string markupPath, object binding)

Parameters

markupPath string

binding object

Returns

IDisposable

RegisterPanel(PluginPanelDescriptor, string, object)

Registers a window whose lifetime may be ended independently while the plugin keeps running. Disposing the token removes the retained window and its sidepanel entry.

public IDisposable RegisterPanel(PluginPanelDescriptor descriptor, string markupPath, object binding)

Parameters

descriptor PluginPanelDescriptor

markupPath string

binding object

Returns

IDisposable

RegisterPanel(PluginUiOwner, PluginPanelDescriptor, string, object)

Registers a window from a markup file on behalf of one plugin.

public IDisposable RegisterPanel(PluginUiOwner owner, PluginPanelDescriptor descriptor, string markupPath, object binding)

Parameters

owner PluginUiOwner

descriptor PluginPanelDescriptor

markupPath string

binding object

Returns

IDisposable

RegisterPanelContent(PluginPanelDescriptor, string, object)

Same as RegisterPanel(PluginPanelDescriptor, string, object), but the markup is passed as text instead of read from a file.

public IDisposable RegisterPanelContent(PluginPanelDescriptor descriptor, string markupContent, object binding)

Parameters

descriptor PluginPanelDescriptor

How the window is identified and presented.

markupContent string

The panel markup itself.

binding object

Object whose properties the markup's {Bindings} resolve against.

Returns

IDisposable

RegisterPanelContent(PluginUiOwner, PluginPanelDescriptor, string, object)

Host-owned registration for in-memory plugin markup.

public IDisposable RegisterPanelContent(PluginUiOwner owner, PluginPanelDescriptor descriptor, string markupContent, object binding)

Parameters

owner PluginUiOwner

descriptor PluginPanelDescriptor

markupContent string

binding object

Returns

IDisposable

ShowClientWindow(PluginClientWindow)

Shows one of the client's own windows. Returns whether it is now visible.

public bool ShowClientWindow(PluginClientWindow window)

Parameters

window PluginClientWindow

Returns

bool

ToggleClientWindow(PluginClientWindow)

Shows one of the client's own windows if it is hidden, hides it if shown. Returns whether the window ended up visible; a no-window host or a window this build does not mount always returns false.

public bool ToggleClientWindow(PluginClientWindow window)

Parameters

window PluginClientWindow

Returns

bool