Class TableSettingDescriptor

Descriptor for a tabular setting: a list of rows, each row is a dictionary of cell values keyed by Columns keys. Hosts render a grid/list editor; consumers read rows via GetValueAsTable(string).

Inheritance

object

SettingDescriptor

TableSettingDescriptor

Inherited Members

SettingDescriptor.Key

SettingDescriptor.DisplayName

SettingDescriptor.Description

SettingDescriptor.IconSvg

SettingDescriptor.IsVisible

SettingDescriptor.IsRequired

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Zaya.Primitives

Assembly: Zaya.Primitives.dll

Syntax

public sealed class TableSettingDescriptor : SettingDescriptor

Remarks

Nested TableSettingDescriptor columns are not supported. Column IsVisible / IsRequired predicates receive the row dictionary only, not the parent settings bag. Stored value shape: List<Dictionary<string, object>> (JSON array of objects).

Constructors

TableSettingDescriptor(string, LocalizedString)

Initializes a new instance of the TableSettingDescriptor class.

Declaration

public TableSettingDescriptor(string key, LocalizedString displayName)

Parameters

Type	Name	Description
string	key	Machine-readable key for this setting.
LocalizedString	displayName	Localizable UI label.

Properties

Columns

Gets or sets the column descriptors (cell schema for each row). Must not contain nested TableSettingDescriptor instances or duplicate keys.

Declaration

public IReadOnlyList<SettingDescriptor> Columns { get; init; }

Property Value

Type	Description
IReadOnlyList<SettingDescriptor>

Methods

CreateDefaultRow()

Builds a new row dictionary filled with each column's default value (when defined). Used by hosts when the user adds a row.

Declaration

public Dictionary<string, object> CreateDefaultRow()

Returns

Type	Description
Dictionary<string, object>