DataControlBase.SelectionMode Property

Gets or sets whether multiple row/cell selection is enabled. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v22.1.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public MultiSelectMode SelectionMode { get; set; }

VB.NET

Public Property SelectionMode As MultiSelectMode

Property Value

Type	Description
MultiSelectMode	A MultiSelectMode enumeration value that specifies the selection mode.

Available values:

Name	Description
None	Multi-selection is disabled.
Row	Allows selection of multiple rows.
Cell	Allows selection of multiple cells.
MultipleRow	Allows toggling the selection of multiple rows.

Remarks

Tip

Topics:

• Multiple Row Selection
• Multiple Cell Selection

Multiple row/cell selection is not allowed if the DataViewBase.NavigationStyle property is set to GridViewNavigationStyle.None and/or the SelectionMode property is set to MultiSelectMode.None.

To enable multiple row selection, set the SelectionMode property to MultiSelectMode.Row.

To enable touch-friendly multiple row selection, set the SelectionMode property to MultiSelectMode.MultipleRow.

To enable multiple cell selection (block selection), set the SelectionMode property to MultiSelectMode.Cell.

To enable single row selection, set the DataViewBase.NavigationStyle property to GridViewNavigationStyle.Row and/or the SelectionMode property to MultiSelectMode.None.

For the CardView, setting the SelectionMode property affects card selection (similar to row selection in the TableView).

To disable card selection, set the SelectionMode property to MultiSelectMode.None or MultiSelectMode.Cell.

Example: How to Select Rows that Contain the Specified Value

This example shows how to select rows whose Unit Price column contains a value equal to or greater than the specified value. To select rows, click the Select button.

View Example: Select Rows that Contain the Specified Value

XAML

<Window.DataContext>
    <local:ViewModel/>
</Window.DataContext>
<Grid>
    <Grid.RowDefinitions>
        <RowDefinition/>
        <RowDefinition Height="Auto"/>
    </Grid.RowDefinitions>
    <dxg:GridControl ItemsSource="{Binding Products}" AutoGenerateColumns="AddNew" SelectionMode="Row" SelectedItems="{Binding Selection}">
        <dxg:GridControl.View>
            <dxg:TableView AutoWidth="True" FadeSelectionOnLostFocus="False"/>
        </dxg:GridControl.View>
    </dxg:GridControl>
    <StackPanel Grid.Row="1" Orientation="Horizontal">
        <TextBlock Text="Minimum Price:" TextAlignment="Right" Padding="4"/>
        <TextBox x:Name="textBox" HorizontalAlignment="Left" Margin="0,0,5,0" Width="50"/>
        <Button Content="Select" HorizontalAlignment="Left" Command="{Binding SelectRowsCommand}" CommandParameter="{Binding Text, ElementName=textBox}"/>
    </StackPanel>
</Grid>

C#

public class ViewModel : ViewModelBase {
    public ViewModel() {
        Products = ProductList.GetData();
        Selection = new ObservableCollection<Product>() { Products.ElementAt(0) };
    }
    public ObservableCollection<Product> Products { get { return this.GetValue<ObservableCollection<Product>>(); } set { SetValue(value); } }
    public ObservableCollection<Product> Selection { get { return this.GetValue<ObservableCollection<Product>>(); } set { SetValue(value); } }

    [Command]
    public void SelectRows(string textValue) {
        var value = double.Parse(textValue);
        Selection = new ObservableCollection<Product>(from item in Products where item.UnitPrice >= value select item);
    }
    public bool CanSelectRows(string textValue) {
        return double.TryParse(textValue, out double value);
    }
}

VB.NET

Public Class ViewModel
    Inherits ViewModelBase

    Public Sub New()
        Products = ProductList.GetData()
        Selection = New ObservableCollection(Of Product)() From {Products.ElementAt(0)}
    End Sub

    Public Property Products As ObservableCollection(Of Product)
        Get
            Return GetValue(Of ObservableCollection(Of Product))()
        End Get

        Set(ByVal value As ObservableCollection(Of Product))
            SetValue(value)
        End Set
    End Property

    Public Property Selection As ObservableCollection(Of Product)
        Get
            Return GetValue(Of ObservableCollection(Of Product))()
        End Get

        Set(ByVal value As ObservableCollection(Of Product))
            SetValue(value)
        End Set
    End Property

    <Command>
    Public Sub SelectRows(ByVal textValue As String)
        Dim value = Double.Parse(textValue)
        Selection = New ObservableCollection(Of Product)(From item In Products Where item.UnitPrice >= value Select item)
    End Sub

    Public Function CanSelectRows(ByVal textValue As String) As Boolean
        Dim value As Double = Nothing
        Return Double.TryParse(textValue, value)
    End Function
End Class

Example: How to Change the Appearance of Focused and Selected Cells

This example demonstrates how to use the View’s CellStyle property to define a custom appearance for focused and selected cells.

View Example: Change the Appearance of Focused and Selected Cells

Window.xaml

<Window.Resources>
    <Style x:Key="SelectionStateCellStyle" TargetType="dxg:LightweightCellEditor">
        <Style.Triggers>
            <Trigger Property="SelectionState" Value="Selected">
                <Setter Property="Background" Value="Red"/>
                <Setter Property="Foreground" Value="White"/>
            </Trigger>
            <Trigger Property="SelectionState" Value="FocusedAndSelected">
                <Setter Property="Background" Value="Gray"/>
                <Setter Property="Foreground" Value="Black"/>
            </Trigger>
        </Style.Triggers>
    </Style>
</Window.Resources>
<Grid>
    <dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew" SelectionMode="Cell">
        <dxg:GridControl.View>
            <dxg:TableView AutoWidth="True" CellStyle="{StaticResource SelectionStateCellStyle}"/>
        </dxg:GridControl.View>
    </dxg:GridControl>
</Grid>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectionMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-data-grid-bind-selected-rows-to-viewmodel-property/CS/GridMVVMSelection/MainWindow.xaml#L18

ItemsSource="{Binding Customers}"
SelectionMode="Row"
SelectedItems="{Binding Selection}">

wpf-data-grid-click-column-header-to-select-all-its-cells/CS/B183292SelectingColumnsByClickOnHeader/MainWindow.xaml#L9

<dxg:GridControl AutoGenerateColumns="AddNew" ItemsSource="{Binding}" SelectionMode="Cell">
    <dxg:GridControl.View>

how-to-select-all-group-subitems-when-a-group-row-is-clicked-wpf-e4617/CS/GridGroupSelect/MainWindow.xaml#L8

<Grid>
    <dxg:GridControl Name="grid" ItemsSource="{Binding}" SelectionMode="Row">
        <dxg:GridControl.Columns>

use-unbounddatasource-to-populate-wpf-data-grid-with-data/CS/UnboundSource/MainWindow.xaml#L33

</dxc:UnboundDataSource>
<dxg:GridControl ItemsSource="{Binding Data, ElementName=unboundDataSource1}" SelectionMode="Row">
    <dxg:GridControl.Columns>

how-to-use-scrollbar-annotations-t534664/CS/WpfApplication25/MainWindow.xaml#L27

</Grid.ColumnDefinitions>
<dxg:GridControl x:Name="myGrid" AutoGenerateColumns="AddNew" EnableSmartColumnsGeneration="True" ItemsSource="{Binding List}" AllowLiveDataShaping ="True" SelectionMode="Cell" Grid.RowSpan="2">
    <dxg:GridControl.View>