Table of Contents

Class MediaBlockPropertyDescriptor

Namespace
VisioForge.Core.MediaBlocks.Catalog
Assembly
VisioForge.Core.dll

Describes one configurable setting of a block: identity, display metadata, type, default and validation range. Generated from the settings CLR type by the catalog; the serialized JSON name is the camelCase form of VisioForge.Core.MediaBlocks.Catalog.MediaBlockPropertyDescriptor.Id.

public class MediaBlockPropertyDescriptor

Inheritance

Inherited Members

Constructors

MediaBlockPropertyDescriptor(string)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Catalog.MediaBlockPropertyDescriptor class.

public MediaBlockPropertyDescriptor(string id)

Parameters

id string

The stable property id, equal to the CLR property name.

Properties

DefaultValue

Gets or sets the default value read from a default-constructed settings object, when available.

public object DefaultValue { get; set; }

Property Value

object

Description

Gets or sets the English description of what the setting does.

public string Description { get; set; }

Property Value

string

DisplayName

Gets or sets the human-readable display name.

public string DisplayName { get; set; }

Property Value

string

EditorKind

Gets or sets the editor kind a UI should present.

public MediaBlockPropertyEditorKind EditorKind { get; set; }

Property Value

MediaBlockPropertyEditorKind

EnumValues

Gets or sets the allowed enum names for enumeration settings.

public string[] EnumValues { get; set; }

Property Value

string[]

Id

Gets the stable property id (the CLR property name).

public string Id { get; }

Property Value

string

IsLiveSafe

Gets or sets a value indicating whether the setting can be changed while the pipeline is running.

public bool IsLiveSafe { get; set; }

Property Value

bool

IsRequired

Gets or sets a value indicating whether the setting must be set before the pipeline can run.

public bool IsRequired { get; set; }

Property Value

bool

IsRuntimeOnly

Gets or sets a value indicating whether the setting is written by the runtime and must not be persisted. Runtime-only properties are excluded from the JSON settings payload.

public bool IsRuntimeOnly { get; set; }

Property Value

bool

MaxValue

Gets or sets the inclusive maximum for numeric settings, when known.

public double? MaxValue { get; set; }

Property Value

double?

MinValue

Gets or sets the inclusive minimum for numeric settings, when known.

public double? MinValue { get; set; }

Property Value

double?

PropertyType

Gets or sets the CLR property type.

public Type PropertyType { get; set; }

Property Value

Type