14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
PluginFormElement14.1 Beta
public abstract class Unbroken.LaunchBox.Plugins.Forms.PluginFormElementA presentation element in a plugin form: a value-bearing field or a group of elements.
Properties
public abstract Unbroken.LaunchBox.Plugins.PluginText? Description { get; }public abstract Unbroken.LaunchBox.Plugins.PluginText? Label { get; }public string? VisibleWhenKey { get; }public string? VisibleWhenValue { get; }
Description 14.1 Beta
public abstract Unbroken.LaunchBox.Plugins.PluginText? Description { get; }Gets the optional localizable description.
Label 14.1 Beta
public abstract Unbroken.LaunchBox.Plugins.PluginText? Label { get; }Gets the localizable label, or null for an unnamed group.
VisibleWhenKey 14.1 Beta
public string? VisibleWhenKey { get; }Gets the ID of the field controlling visibility, or null when always visible.
VisibleWhenValue 14.1 Beta
public string? VisibleWhenValue { get; }Gets the controlling field value that makes this element visible.
Methods
VisibleWhen 14.1 Beta
public virtual Unbroken.LaunchBox.Plugins.Forms.PluginFormElement VisibleWhen(string key, string value)Returns a copy displayed only when a field has the specified value.
key14.1 Beta- The controlling field ID, matched without regard to case. A missing controller leaves the element visible.
value14.1 Beta- The required value. Boolean values are compared as Booleans; other values are ordinal.