DataGridTableStyle.AllowSorting Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

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

public:
 property bool AllowSorting { bool get(); void set(bool value); };

public bool AllowSorting { get; set; }

member this.AllowSorting : bool with get, set

Public Property AllowSorting As Boolean

Property Value

Boolean

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

Examples

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:
   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 );
   }

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);
}

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

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

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

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.

This property overrides the DataGrid.AllowSorting property.

See also

• AllowSortingChanged
• AllowSorting