MigsLab SDKARX.SDK documentation
Ctrl K

SQL Server · Types · Other public types

ArxSelectionSetExtensions

Definition

Namespace
ARX.SDK.Extensions
Package
ARX.SDK
C#
public static class ArxSelectionSetExtensions

Reading selection sets. Retrieve returns the raw stored value; these turn it into the code, or into an ArxSelectionSetValue with display text from the developer's catalog.

Methods

  • static T? GetSelectionSetValue<T>(this ArxEntity entity, string attribute)

    The raw code as T, whether the attribute holds a plain value or an ArxSelectionSetValue. Integer codes convert between integer types and to enums; string codes convert to enums by name. Missing or null gives default.

    Parameter Type Description
    entitythis ArxEntityThe record that was read.
    attributestringThe column that holds the selection set's value.
  • static ArxSelectionSetValue? GetSelectionSet(this ArxEntity entity, string attribute, string setName, IArxSelectionSetCatalog catalog)

    The attribute decoded through set setName of catalog: multiple-choice storage (array, flags, delimited, JSON) turned back into Values, with the matched Options and DisplayText. A stored code missing from the set doesn't throw: its option is null and IsDefined is false. Missing or null gives null.

    Parameter Type Description
    entitythis ArxEntityThe record that was read.
    attributestringThe column that holds the selection set's value.
    setNamestringThe selection set's name, as the catalog declares it.
    catalogIArxSelectionSetCatalogThe catalog that declares the selection set.
  • static string? GetSelectionSetDisplayText(this ArxEntity entity, string attribute, string setName, IArxSelectionSetCatalog catalog)

    The display text of the attribute's option (or options, joined with ", "), from the catalog; null when missing, null or not in the set.

    Parameter Type Description
    entitythis ArxEntityThe record that was read.
    attributestringThe column that holds the selection set's value.
    setNamestringThe selection set's name, as the catalog declares it.
    catalogIArxSelectionSetCatalogThe catalog that declares the selection set.