ChoiceMetadata
Metadata for a Dataverse single-select choice (option set / picklist) column, including the available choice values.
ChoiceMetadata Class
Properties
Name | Type | Default | Description |
|---|---|---|---|
ChoiceLogicalName | string | The logical name of the choice (option set) definition in Dataverse. | |
Choices | List<ChoiceValueMetadata> | The list of available choice values with their display names. | |
ColumnName | string | The logical name of the column in Dataverse (e.g. 'firstname', 'emailaddress1'). | |
ColumnType | ColumnType | Choice | Returns Choice. |
Description | string? | The localized description of the column, or null if no description is configured. | |
DisplayName | string | The localized display name of the column as configured in Dataverse. | |
IsGlobal | bool | False | Indicates whether this choice is a global option set shared across multiple tables. |
IsValidForCreate | bool | False | Indicates whether this column can be set when creating a new record. |
IsValidForUpdate | bool | False | Indicates whether this column can be modified when updating an existing record. |
RequiredLevel | RequiredLevel | None | The required level of the column (None, SystemRequired, ApplicationRequired, or Recommended). |
Name:
ChoiceLogicalNameType:
string
Description:
The logical name of the choice (option set) definition in Dataverse.
Name:
ChoicesType:
List<ChoiceValueMetadata>
Description:
The list of available choice values with their display names.
Name:
ColumnNameType:
string
Description:
The logical name of the column in Dataverse (e.g. 'firstname', 'emailaddress1').
Name:
ColumnTypeType:
ColumnType
Default:
Choice
Description:
Returns Choice.
Name:
DescriptionType:
string?
Description:
The localized description of the column, or null if no description is configured.
Name:
DisplayNameType:
string
Description:
The localized display name of the column as configured in Dataverse.
Name:
IsGlobalType:
bool
Default:
False
Description:
Indicates whether this choice is a global option set shared across multiple tables.
Name:
IsValidForCreateType:
bool
Default:
False
Description:
Indicates whether this column can be set when creating a new record.
Name:
IsValidForUpdateType:
bool
Default:
False
Description:
Indicates whether this column can be modified when updating an existing record.
Name:
RequiredLevelType:
RequiredLevel
Default:
None
Description:
The required level of the column (None, SystemRequired, ApplicationRequired, or Recommended).
ChoiceValueMetadata Class
Properties
Name | Type | Default | Description |
|---|---|---|---|
DisplayName | string | The localized display name of the choice option. | |
Value | int | 0 | The integer value of the choice option. |
Name:
DisplayNameType:
string
Description:
The localized display name of the choice option.
Name:
ValueType:
int
Default:
0
Description:
The integer value of the choice option.