LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

PluginFormGroup14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Forms.PluginFormGroup : Unbroken.LaunchBox.Plugins.Forms.PluginFormElement
Groups related fields and groups under an optional localizable heading.

Remarks

Groups affect presentation only. They have no field ID or submitted value.

Inheritance and interfaces

Constructors

PluginFormGroup 14.1 Beta

C#
public PluginFormGroup(Unbroken.LaunchBox.Plugins.PluginText? label, System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Forms.PluginFormElement> elements, Unbroken.LaunchBox.Plugins.PluginText? description = null)
Creates an ordered group containing fields, nested groups, or both.
label 14.1 Beta
The heading, or null for an unnamed group.
elements 14.1 Beta
The child elements in presentation order.
description 14.1 Beta
Optional localizable text below the heading.

PluginFormGroup 14.1 Beta

C#
public PluginFormGroup(Unbroken.LaunchBox.Plugins.PluginText? label, System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Forms.PluginFormField> fields)
Creates an ordered group of fields.
label 14.1 Beta
The heading, or null for an unnamed group.
fields 14.1 Beta
The fields in this group.

Properties

Description 14.1 Beta

C#
public override Unbroken.LaunchBox.Plugins.PluginText? Description { get; }
Gets the optional localizable description.

Elements 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Forms.PluginFormElement> Elements { get; }
Gets the child elements in presentation order.

Label 14.1 Beta

C#
public override Unbroken.LaunchBox.Plugins.PluginText? Label { get; }
Gets the localizable label, or null for an unnamed group.

Methods

VisibleWhen 14.1 Beta

C#
public override Unbroken.LaunchBox.Plugins.Forms.PluginFormGroup VisibleWhen(string key, string value)
Returns a copy displayed only when a field has the specified value.
key 14.1 Beta
The controlling field ID, matched without regard to case. A missing controller leaves the element visible.
value 14.1 Beta
The required value. Boolean values are compared as Booleans; other values are ordinal.

Returns

The element with its visibility condition. A hidden group hides all descendants. Hidden fields retain their values and participate in submission.