MultiSelectChoiceEdit

The MultiSelectChoiceEdit component renders a Dataverse multi-select choice column, allowing users to select multiple values from a predefined set of options.

React
Blazor

Editor Type

Set EditorType to choose the rendering style. The default renders as a checkbox group. Use CheckboxOrientation to control vertical or horizontal layout, and WrapCheckboxes to control wrapping behavior.

React
Blazor

Sort Order

Set SortOrder to control how the options are ordered. Options include Default, DisplayName, DisplayNameDescending, Value, and ValueDescending.

React
Blazor

Example

A basic MultiSelectChoiceEdit bound to a multi-select choice column.

React example
Blazor example
Red Blue Orange Purple Yellow Black White Brown Green
React TypeScript
Razor

Configuration Options

Use the controls below to explore the available properties.

React example
Blazor example
Readonly? Required? Disabled? DefaultDisplay NameDisplay Name DescendingValueValue Descending DisableRemove VerticalHorizontal Wrap Checkboxes?
Red Blue Orange Purple Yellow Black White Brown Green
React TypeScript
Razor
React Blazor

MultiSelectChoiceEdit Class

Parameters

Name
Type
Default
Description
CheckboxOrientationComponentOrientation
Vertical
Orientation of the checkboxes.
ChildContentRenderFragment?
Child content of the component
ColumnName*string
Column logical name to bind the editor to from the table record.
Descriptionstring?
Description to be displayed in the tooltip.
Disabledbool?
Should the editor be disabled.
DisplayLabelWhenAvailablebool
True
Specifies whether to display a lable if available.
DisplayTooltipWhenAvailablebool
True
Specifies whether to display a tooltip if available.
DisplayValidationErrorMessagebool
True
Should a validation error message be displayed when the component fails validation?
InvalidChoiceValuesIEnumerable<int>?
Optionally specify what values are invalid.
InvalidValueBehaviorChoiceInvalidValueBehavior
Remove
Determines the behavior of invalid values. Only applicable when either the BaseChoiceEditCommon.ValidChoiceValues or BaseChoiceEditCommon.InvalidChoiceValues parameter is supplied.
IsVisiblebool
True
Is the editor visible.
Labelstring?
Text to be displayed as a label for the editor.
ReadOnlybool?
Should the editor be read-only.
Requiredbool?
Should the value be required.
SortChoiceValueSort
Default
Determines how the values are sorted.
ValidChoiceValuesIEnumerable<int>?
Optionally specify what values are valid.
ValueList<int>
Value of the column.
WrapCheckboxesbool
True
When true, checkboxes wrap onto multiple lines instead of truncating.
Name: CheckboxOrientation
Type: ComponentOrientation
Default: Vertical
Description: Orientation of the checkboxes.
Name: ChildContent
Type: 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: Description
Type: string?
Description: Description to be displayed in the tooltip.
Name: Disabled
Type: bool?
Description: Should the editor be disabled.
Name: DisplayLabelWhenAvailable
Type: bool
Default: True
Description: Specifies whether to display a lable if available.
Name: DisplayTooltipWhenAvailable
Type: bool
Default: True
Description: Specifies whether to display a tooltip if available.
Name: DisplayValidationErrorMessage
Type: bool
Default: True
Description: Should a validation error message be displayed when the component fails validation?
Name: InvalidChoiceValues
Type: IEnumerable<int>?
Description: Optionally specify what values are invalid.
Name: InvalidValueBehavior
Type: ChoiceInvalidValueBehavior
Default: Remove
Description: Determines the behavior of invalid values. Only applicable when either the BaseChoiceEditCommon.ValidChoiceValues or BaseChoiceEditCommon.InvalidChoiceValues parameter is supplied.
Name: IsVisible
Type: bool
Default: True
Description: Is the editor visible.
Name: Label
Type: string?
Description: Text to be displayed as a label for the editor.
Name: ReadOnly
Type: bool?
Description: Should the editor be read-only.
Name: Required
Type: bool?
Description: Should the value be required.
Name: Sort
Type: ChoiceValueSort
Default: Default
Description: Determines how the values are sorted.
Name: ValidChoiceValues
Type: IEnumerable<int>?
Description: Optionally specify what values are valid.
Name: Value
Type: List<int>
Description: Value of the column.
Name: WrapCheckboxes
Type: bool
Default: True
Description: When true, checkboxes wrap onto multiple lines instead of truncating.

Events

Name
Type
Description
ValueChangedEventCallback<ColumnValueBase>
Gets or sets a callback that updates the bound value.
Name: ValueChanged
Type: EventCallback<ColumnValueBase>
Description: Gets or sets a callback that updates the bound value.

Methods

Name
Parameters
Type
Description
GetValidationErrorsList<string>
Returns a collection of the current validation errors.
Name: GetValidationErrors
Type: List<string>
Description: Returns a collection of the current validation errors.