ArxSelectionSetValue

Definition

Namespace

ARX.SDK.Services

Package

ARX.SDK

public sealed class ArxSelectionSetValue

Constructor

• ArxSelectionSetValue(string setName, object value)

  A single-choice value: value is the option's code (an integer, string, char, bool, decimal or Guid).

  Parameter	Type	Description
  setName	string	The catalog set to check against. Required when writing; a missing name is reported as ARX1006 by the provider.
  value	object	The option's code. Not null, and not a collection (use Multiple).

Also created with:

• ArxSelectionSetValue.Multiple(string setName, params object[] values)

  A multiple-choice value. An empty list means no option is chosen.

  Parameter	Type	Description
  setName	string	The selection set's name in the catalog.
  values	params object[]	The chosen codes.

• ArxSelectionSetValue.Multiple(string setName, IEnumerable values)

  A multiple-choice value from any sequence of codes (int[], List<string>, …). An empty sequence means no option is chosen. A single string is one code, not a sequence of characters.

  Parameter	Type	Description
  setName	string	The selection set's name in the catalog.
  values	IEnumerable	The chosen codes.

Properties

• string SetName { get; }

  The catalog set this value belongs to.

• object? Value { get; }

  The single-choice code; null for a multiple-choice value.

• IReadOnlyList<object> Values { get; }

  Every chosen code: one for a single-choice value, zero or more for a multiple-choice value.

• bool IsMultiple { get; }

  True when created with Multiple or decoded from a multiple-choice set.

• IReadOnlyList<ArxSelectionSetOption?>? Options { get; }

  The catalog options matching Values, in the same order, when the value was decoded from storage; an entry is null when the stored code isn't in the set. Null for values created by the caller.

• bool IsDefined { get; }

  True when the value was decoded and every stored code is an option of the set.

• string? DisplayText { get; }

  The display text of the matched option (single choice), or of every matched option joined with ", " in stored order (multiple choice). Null when not decoded, or when a single-choice code isn't in the set.

Usage

order["status"] = new ArxSelectionSetValue("OrderStatus", "OPEN");

Store every kind of value, scenario 2

Used in:

• Store every kind of valueCreate

Notes