[WPF][DataGrid] 列の並び替えを許可する

本記事の概要

この記事では、DataGrid で列の並び替えを許可する方法について説明します。
※データ表示方法については過去記事「データグリッドにデータを表示する方法」を参照してください。

公式サイト情報はコチラを参照してください。

列の並び替えを許可する

WPF の DataGrid は、列ごとにソートをする機能が備わっています。

列の並び替え（ソート）を許可するには、CanUserSortColumns プロパティで制御することができます。true をセットすると列の並び替えを許可し、false をセットすると列の並び替えの変更をできなくします。

以下の例では 、チェックボックスがチェックされたときに CanUserSortColumns  プロパティ に true をセットして列の並び替えの変更を許可し、チェックを外したときは CanUserSortColumns  プロパティ に false をセットして、列の並び替えの変更をできなくします。

XAML の例

<Window x:Class="WpfSample.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfSample"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="25"/>
            <RowDefinition />
        </Grid.RowDefinitions>
        <CheckBox 
            Content="CanUserSortColumns"
            Checked="SortColumns_Checked" 
            Unchecked="SortColumns_Unchecked" Grid.Row="0"/>
        <DataGrid x:Name="dataGrid" AutoGenerateColumns="False"
                  Grid.Row="1">
            <DataGrid.Columns>
                <DataGridTextColumn Header="Id" Binding="{Binding Id}" CanUserSort="False"/>
                <DataGridTextColumn Header="氏名" Binding="{Binding Name}"/>
                <DataGridTextColumn Header="年齢" Binding="{Binding Age}"/>
                <DataGridTextColumn Header="郵便番号" Binding="{Binding ZipCode}"/>
                <DataGridTextColumn Header="住所" Binding="{Binding Address}" />
              </DataGrid.Columns>
        </DataGrid>
    </Grid>
</Window>

C# の例

private void SortColumns_Checked(object sender, RoutedEventArgs e)
{
    dataGrid.CanUserReorderColumns = true;
}

private void SortColumns_Unchecked(object sender, RoutedEventArgs e)
{
    dataGrid.CanUserReorderColumns = false;
}

以下に、実行例を示します。氏名をクリックして並び替えをしています。

実行例

特定の列の並び替えを許可する

DataGrid 全体での並び替えの許可ではなく、列ごとに並び替えの設定をすることができます。

CanUserSort プロパティに true を設定すると並び替えを許可し、false をセットすると並び替えをできなくします。

<DataGridTextColumn Header="Id" Binding="{Binding Id}" CanUserSort="False"/>

Please follow and like us: