• Article

DataGrid.CanUserSortColumns Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets a value that indicates whether the user can sort columns by clicking the column header.

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls.Data (in System.Windows.Controls.Data.dll)

Syntax

'Declaration
Public Property CanUserSortColumns As Boolean

public bool CanUserSortColumns { get; set; }

<sdk:DataGrid CanUserSortColumns="bool"/>

Property Value

Type: System.Boolean
true if the user can sort columns; otherwise, false. The default is true.

Remarks

Dependency property identifier field: CanUserSortColumnsProperty

You can set this behavior for individual columns by setting the DataGridColumn.CanUserSort property. If the DataGridColumn.CanUserSort property and the DataGrid.CanUserSortColumns property are both set, a value of false will take precedence over a value of true.

Examples

The following code example demonstrates how to set the CanUserSortColumns property in code. This example is part of a larger example available in the Walkthrough: Customizing the DataGrid Control Using Properties topic.

Private Sub cbColSort_Changed(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
    Dim cb As CheckBox = sender
    If Me.dataGrid1 IsNot Nothing Then
        Me.dataGrid1.CanUserSortColumns = cb.IsChecked
    End If
End Sub

private void cbColSort_Changed(object sender, RoutedEventArgs e)
{
    CheckBox cb = sender as CheckBox;
    if (this.dataGrid1 != null)
        this.dataGrid1.CanUserSortColumns = (bool)cb.IsChecked;
}

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.