DataGridTableStyle.AllowSorting Property

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

[Visual Basic]
Public Property AllowSorting As Boolean
[C#]
public bool AllowSorting {get; set;}
[C++]
public: __property bool get_AllowSorting();
public: __property void set_AllowSorting(bool);
[JScript]
public function get AllowSorting() : Boolean;
public function set AllowSorting(Boolean);

Property Value

true if sorting is allowed; otherwise, false. The default is true.

Remarks

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.

Example

[Visual Basic, C#, C++] The following 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 assumes you have a DataGrid with a System.Data.DataSet that contains some data, a Button and a Label on a Form.

[Visual Basic] 
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

[C#] 
private void DataGridTableStyle_Sample_Load(object sender,
                                       EventArgs e)
{
   myDataGridTableStyle1 = new DataGridTableStyle();

   mylabel.Text = "Sorting Status :" + 
         myDataGridTableStyle1.AllowSorting.ToString();
   if(myDataGridTableStyle1.AllowSorting == true)
   {
      btnApplyStyles.Text = "Remove Sorting";
   }
   else
   {
      btnApplyStyles.Text = "Apply Sorting";
   }
   // Attach custom event handlers.
   myDataGridTableStyle1.AllowSortingChanged += 
               new System.EventHandler(AllowSortingChanged_Handler);
   myDataGridTableStyle1.MappingName = "Customers";
} 
private void AllowSortingChanged_Handler(object sender,EventArgs e)
{         
   mylabel.Text = "Sorting Status :" 
         + myDataGridTableStyle1.AllowSorting.ToString();
}     
private void btnApplyStyles_Click(object sender, EventArgs e)
{       

   if(myDataGridTableStyle1.AllowSorting == true)
   {            
      // Remove sorting.
      myDataGridTableStyle1.AllowSorting = false; 
      btnApplyStyles.Text = "Allow Sorting";
   }
   else
   {
      // Allow sorting.
      myDataGridTableStyle1.AllowSorting = true;
      btnApplyStyles.Text = "Remove Sorting";
   } 

   mylabel.Text = "Sorting Status :" + myDataGridTableStyle1.AllowSorting;
   // Add the DataGridTableStyle to DataGrid.
   myDataGrid.TableStyles.Add(myDataGridTableStyle1);
}

[C++] 
private:
    void DataGridTableStyle_Sample_Load(Object* /*sender*/,
        EventArgs* /*e*/) {
            myDataGridTableStyle1 = new DataGridTableStyle();

            mylabel->Text = String::Concat(S"Sorting Status : ", 
                __box(myDataGridTableStyle1->AllowSorting));
            if (myDataGridTableStyle1->AllowSorting == true) {
                btnApplyStyles->Text = S"Remove Sorting";
            } else {
                btnApplyStyles->Text = S"Apply Sorting";
            }
            // Attach custom event handlers.
            myDataGridTableStyle1->AllowSortingChanged += 
                new System::EventHandler(this, &DataGridTableStyle_Sample::AllowSortingChanged_Handler);
            myDataGridTableStyle1->MappingName = S"Customers";
        }

        void AllowSortingChanged_Handler(Object* /*sender*/, 
            EventArgs* /*e*/) {
            mylabel->Text = String::Concat(S"Sorting Status : ",
                __box( myDataGridTableStyle1->AllowSorting));
        }

        void btnApplyStyles_Click(Object* /*sender*/, EventArgs* /*e*/) {

            if (myDataGridTableStyle1->AllowSorting == true) {
                // Remove sorting.
                myDataGridTableStyle1->AllowSorting = false;
                btnApplyStyles->Text = S"Allow Sorting";
            } else {
                // Allow sorting.
                myDataGridTableStyle1->AllowSorting = true;
                btnApplyStyles->Text = S"Remove Sorting";
            }

            mylabel->Text = String::Concat(S"Sorting Status : ", 
                __box(myDataGridTableStyle1->AllowSorting));
            // Add the DataGridTableStyle to DataGrid.
            myDataGrid->TableStyles->Add(myDataGridTableStyle1);
        }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

DataGridTableStyle Class | DataGridTableStyle Members | System.Windows.Forms Namespace | AllowSortingChanged