MigsLab SQL Server · Types · Other public types
ArxSelectionSetCatalogBuilder
Definition
- Namespace
ARX.SDK.Services- Package
ARX.SDK
public sealed class ArxSelectionSetCatalogBuilderBuilds an ArxSelectionSetCatalog. Not thread-safe; build once, at startup.
Methods
ArxSelectionSetCatalogBuilder Add(ArxSelectionSetDefinition set)Adds a set the developer defined (for example loaded from their own option tables).
Parameter Type Description setArxSelectionSetDefinitionA selection set built elsewhere. ArxSelectionSetCatalogBuilder Add(string name, ArxSelectionSetKind kind, params (object Value, string DisplayText)[] options)Adds a single-choice set; options get their order from their position.
Parameter Type Description namestringThe set's name, used when writing and reading its values. kindArxSelectionSetKindWhat its codes are: integers, text or single characters. optionsparams (object Value, string DisplayText)[]The options: each code and its display text. ArxSelectionSetCatalogBuilder Add(string name, ArxSelectionSetKind kind, ArxSelectionSetMultiplicity multiplicity, params (object Value, string DisplayText)[] options)Adds a set with the given storage form; options get their order from their position.
Parameter Type Description namestringThe set's name, used when writing and reading its values. kindArxSelectionSetKindWhat its codes are: integers, text or single characters. multiplicityArxSelectionSetMultiplicityOne option per column, or several stored as an array. optionsparams (object Value, string DisplayText)[]The options: each code and its display text. ArxSelectionSetCatalogBuilder AddEnum<TEnum>(string? name = null)Adds a single-choice Integer set from a .NET enum: codes are the enum's values (in its underlying type), display text its names.
Parameter Type Description namestring?= nullThe set's name; the enum's name when null. ArxSelectionSetCatalogBuilder AddFlagsEnum<TEnum>(string? name = null)Adds a Flags set from a
[Flags]enum. The zero member ("None") isn't an option; every other member must be a single bit.Parameter Type Description namestring?= nullThe set's name; the enum's name when null. ArxSelectionSetCatalog Build()The catalog, read-only from now on.