ChoiceEdit
The ChoiceEdit component renders a Dataverse choice (option set/picklist) column as a dropdown or radio button group for single-value selection.
Editor Type
Set EditorType to choose between ChoiceEditType.Dropdown (default) or ChoiceEditType.RadioButtons. When using radio buttons, use RadioButtonOrientation to control vertical or horizontal layout.
Sort Order
Set SortOrder to control how the options are ordered. Options include Default (Dataverse order), DisplayName, DisplayNameDescending, Value, and ValueDescending.
Example
A basic ChoiceEdit bound to a choice column.
Configuration Options
Use the controls below to explore the available properties.
ChoiceEdit Class
Parameters
Name | Type | Default | Description |
|---|---|---|---|
ChildContent | RenderFragment? | Child content of the component | |
ColumnName* | string | Column logical name to bind the editor to from the table record. | |
Description | string? | Description to be displayed in the tooltip. | |
Disabled | bool? | Should the editor be disabled. | |
DisplayChoiceColors | bool | False | When |
DisplayLabelWhenAvailable | bool | True | Specifies whether to display a lable if available. |
DisplayNullChoice | bool? | Whether to show a '(none)' choice that clears the column back to null. When omitted, the default is required-aware: a required column hides it (the user must pick a real value); a non-required column shows it. Set explicitly to override either default. | |
DisplayTooltipWhenAvailable | bool | True | Specifies whether to display a tooltip if available. |
DisplayValidationErrorMessage | bool | True | Should a validation error message be displayed when the component fails validation? |
EditorType | ChoiceEditType | Dropdown | Type of editor to render |
InvalidChoiceValues | IEnumerable<int>? | Optionally specify what values are invalid. | |
InvalidValueBehavior | ChoiceInvalidValueBehavior | Remove | Determines the behavior of invalid values. Only applicable when either the BaseChoiceEditCommon.ValidChoiceValues or BaseChoiceEditCommon.InvalidChoiceValues parameter is supplied. |
IsVisible | bool | True | Is the editor visible. |
Label | string? | Text to be displayed as a label for the editor. | |
RadioButtonOrientation | ComponentOrientation | Vertical | Orientation of the radio buttons. Only valid when the BaseChoiceEdit.EditorType is set to ChoiceEditType.RadioButtons. |
ReadOnly | bool? | Should the editor be read-only. | |
Required | bool? | Should the value be required. | |
Sort | ChoiceValueSort | Default | Determines how the values are sorted. |
ValidChoiceValues | IEnumerable<int>? | Optionally specify what values are valid. | |
Value | int? | Value of the column. | |
WrapRadioButtons | bool | True | When |
Name:
ChildContentType:
RenderFragment?
Description:
Child content of the component
Name:
ColumnName*Type:
string
Description:
Column logical name to bind the editor to from the table record.
Name:
DescriptionType:
string?
Description:
Description to be displayed in the tooltip.
Name:
DisabledType:
bool?
Description:
Should the editor be disabled.
Name:
DisplayChoiceColorsType:
bool
Default:
False
Description:
When true , a small swatch of the colour each option is given in Dataverse is shown beside it, and beside the selected value of a closed dropdown. Options with no colour get an empty space, so the labels still line up. Defaults to false .
Name:
DisplayLabelWhenAvailableType:
bool
Default:
True
Description:
Specifies whether to display a lable if available.
Name:
DisplayNullChoiceType:
bool?
Description:
Whether to show a '(none)' choice that clears the column back to null. When omitted, the default is required-aware: a required column hides it (the user must pick a real value); a non-required column shows it. Set explicitly to override either default.
Name:
DisplayTooltipWhenAvailableType:
bool
Default:
True
Description:
Specifies whether to display a tooltip if available.
Name:
DisplayValidationErrorMessageType:
bool
Default:
True
Description:
Should a validation error message be displayed when the component fails validation?
Name:
EditorTypeType:
ChoiceEditType
Default:
Dropdown
Description:
Type of editor to render
Name:
InvalidChoiceValuesType:
IEnumerable<int>?
Description:
Optionally specify what values are invalid.
Name:
InvalidValueBehaviorType:
ChoiceInvalidValueBehavior
Default:
Remove
Description:
Determines the behavior of invalid values. Only applicable when either the
BaseChoiceEditCommon.ValidChoiceValues or BaseChoiceEditCommon.InvalidChoiceValues parameter is supplied.Name:
IsVisibleType:
bool
Default:
True
Description:
Is the editor visible.
Name:
LabelType:
string?
Description:
Text to be displayed as a label for the editor.
Name:
RadioButtonOrientationType:
ComponentOrientation
Default:
Vertical
Description:
Orientation of the radio buttons. Only valid when the
BaseChoiceEdit.EditorType is set to ChoiceEditType.RadioButtons.Name:
ReadOnlyType:
bool?
Description:
Should the editor be read-only.
Name:
RequiredType:
bool?
Description:
Should the value be required.
Name:
SortType:
ChoiceValueSort
Default:
Default
Description:
Determines how the values are sorted.
Name:
ValidChoiceValuesType:
IEnumerable<int>?
Description:
Optionally specify what values are valid.
Name:
ValueType:
int?
Description:
Value of the column.
Name:
WrapRadioButtonsType:
bool
Default:
True
Description:
When true (the default), horizontal radio buttons that run out of room wrap onto the next row; when false , they stay on one row, which scrolls. Has no effect on vertical ones.
Events
Name | Type | Description |
|---|---|---|
ValueChanged | EventCallback<ColumnValueBase> | Gets or sets a callback that updates the bound value. |
Name:
ValueChangedType:
EventCallback<ColumnValueBase>
Description:
Gets or sets a callback that updates the bound value.
Methods
Name | Parameters | Type | Description |
|---|---|---|---|
GetValidationErrors | List<string> | Returns a collection of the current validation errors. |
Name:
GetValidationErrorsType:
List<string>
Description:
Returns a collection of the current validation errors.