This documentation is archived and is not being maintained.

DataGridTableStyle.AllowSorting Property

Indicates whether sorting is allowed on the grid table when this DataGridTableStyle is used.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

'Declaration
Public Property AllowSorting As Boolean

Property Value

Type: System.Boolean
true if sorting is allowed; otherwise, false. The default is true.

When the AllowSorting property is set to true, a triangle appears in each column header indicating the direction of the sort. The user can click on any column header to sort the grid by that column. Clicking the column a second time changes the direction of the sort.

This property overrides the DataGrid.AllowSorting property.

The following code example allows you to toggle sorting availability on a DataGrid by clicking a button and the current sorting status is displayed in a label. This example requires that you have a DataGrid with a System.Data.DataSet that contains some data, a Button and a Label on a Form.


Private Sub DataGridTableStyle_Sample_Load(ByVal sender As Object, _
                        ByVal e As EventArgs) Handles MyBase.Load
   myDataGridTableStyle1 = New DataGridTableStyle()

   mylabel.Text = "Sorting Status :" + myDataGridTableStyle1.AllowSorting.ToString()
   If myDataGridTableStyle1.AllowSorting = True Then
      btnApplyStyles.Text = "Remove Sorting"
   Else
      btnApplyStyles.Text = "Apply Sorting"
   End If
   ' Attach custom event handlers.
   AddHandler myDataGridTableStyle1.AllowSortingChanged, AddressOf AllowSortingChanged_Handler
   myDataGridTableStyle1.MappingName = "Customers"
End Sub 'DataGridTableStyle_Sample_Load

Private Sub AllowSortingChanged_Handler(ByVal sender As Object, ByVal e As EventArgs)
   mylabel.Text = "Sorting Status :" + myDataGridTableStyle1.AllowSorting.ToString()
End Sub 'AllowSortingChanged_Handler

Private Sub btnApplyStyles_Click(ByVal sender As Object, _
                                 ByVal e As EventArgs) Handles btnApplyStyles.Click
   If myDataGridTableStyle1.AllowSorting = True Then
      ' Remove sorting.
      myDataGridTableStyle1.AllowSorting = False
      btnApplyStyles.Text = "Allow Sorting"
   Else
      ' Allow sorting.
      myDataGridTableStyle1.AllowSorting = True
      btnApplyStyles.Text = "Remove Sorting"
   End If

   mylabel.Text = "Sorting Status :" + myDataGridTableStyle1.AllowSorting.ToString
   ' Add the DataGridTableStyle to DataGrid.
   myDataGrid.TableStyles.Add(myDataGridTableStyle1)
End Sub 'btnApplyStyles_Click


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: