Class ParamHint

Inheritance
ParamHint
Implements
Namespace: MOSAIC.Components.Factory
Assembly: MOSAIC.dll
Syntax
public sealed record ParamHint : IEquatable<ParamHint>

Constructors

ParamHint(string, ParamKind, object?, string[]?, string?, string[]?)

Declaration
public ParamHint(string Name, ParamKind Kind, object? Default = null, string[]? Choices = null, string? VisibleWhen = null, string[]? VisibleWhenValues = null)
Parameters
Type Name Description
string Name
ParamKind Kind
object Default
string[] Choices
string VisibleWhen

Name of a controlling (enum) param; when set, this param is only shown in the dialog while that param's value is one of VisibleWhenValues. Purely a UI concern — the block still reads params positionally, so hidden params retain their positions and are emitted with their current values, initially populated from the defaults.

string[] VisibleWhenValues

Properties

Choices

Declaration
public string[]? Choices { get; init; }
Property Value
Type Description
string[]

Default

Declaration
public object? Default { get; init; }
Property Value
Type Description
object

Kind

Declaration
public ParamKind Kind { get; init; }
Property Value
Type Description
ParamKind

Name

Declaration
public string Name { get; init; }
Property Value
Type Description
string

VisibleWhen

Name of a controlling (enum) param; when set, this param is only shown in the dialog while that param's value is one of VisibleWhenValues. Purely a UI concern — the block still reads params positionally, so hidden params retain their positions and are emitted with their current values, initially populated from the defaults.

Declaration
public string? VisibleWhen { get; init; }
Property Value
Type Description
string

VisibleWhenValues

Declaration
public string[]? VisibleWhenValues { get; init; }
Property Value
Type Description
string[]

Implements

IEquatable<T>

Search documentation

Start typing to search the documentation.