DataGridTableStyle::AllowSorting Property

.NET Framework (current version)
 

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)

C#
C++
F#
VB
Copy 
public:
property bool AllowSorting {
	bool get();
	void set(bool value);
}

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.

C#
C++
VB
Copy 
private:
   void DataGridTableStyle_Sample_Load( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      myDataGridTableStyle1 = gcnew DataGridTableStyle;
      mylabel->Text = String::Concat( "Sorting Status : ", myDataGridTableStyle1->AllowSorting );
      if ( myDataGridTableStyle1->AllowSorting == true )
      {
         btnApplyStyles->Text = "Remove Sorting";
      }
      else
      {
         btnApplyStyles->Text = "Apply Sorting";
      }

      myDataGridTableStyle1->AllowSortingChanged += gcnew System::EventHandler(
         this, &DataGridTableStyle_Sample::AllowSortingChanged_Handler );
      myDataGridTableStyle1->MappingName = "Customers";
   }

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

   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 = String::Concat( "Sorting Status : ", myDataGridTableStyle1->AllowSorting );

      // Add the DataGridTableStyle to DataGrid.
      myDataGrid->TableStyles->Add( myDataGridTableStyle1 );
   }

.NET Framework
Available since 1.1
Return to top
Show: