DataGrid.TableStyles Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the collection of DataGridTableStyle objects for the grid.

public:
 property System::Windows::Forms::GridTableStylesCollection ^ TableStyles { System::Windows::Forms::GridTableStylesCollection ^ get(); };

public System.Windows.Forms.GridTableStylesCollection TableStyles { get; }

member this.TableStyles : System.Windows.Forms.GridTableStylesCollection

Public ReadOnly Property TableStyles As GridTableStylesCollection

Property Value

GridTableStylesCollection

A GridTableStylesCollection that represents the collection of DataGridTableStyle objects.

Examples

The following code example creates one DataGridTableStyle for each DataTable found in a DataSet, and sets the MappingName of the DataGridTableStyle to the TableName of the DataTable. The DataGridTableStyle is then added to the GridTableStylesCollection returned by the TableStyles property. The example also prints the MappingName of each DataGridColumnStyle in the GridColumnStylesCollection returned by the GridColumnStyles property of each DataGridTableStyle in the GridTableStylesCollection.

private:
   void AddTables( DataGrid^ myDataGrid, DataSet^ myDataSet )
   {
      for each ( DataTable^ t in myDataSet->Tables )
      {
         DataGridTableStyle^ myGridTableStyle =
            gcnew DataGridTableStyle;
         myGridTableStyle->MappingName = t->TableName;
         myDataGrid->TableStyles->Add( myGridTableStyle );
         
         /* Note that DataGridColumnStyle objects will
            be created automatically for the first DataGridTableStyle
            when you add it to the GridTableStylesCollection.*/
      }
   }

   void PrintGridStyleInfo( DataGrid^ myDataGrid )
   {
      /* Print the MappingName of each DataGridTableStyle,
         and the MappingName of each DataGridColumnStyle. */
      for each ( DataGridTableStyle^ myGridStyle in
         myDataGrid->TableStyles )
      {
         Console::WriteLine( myGridStyle->MappingName );
         for each ( DataGridColumnStyle^ myColumnStyle in
            myGridStyle->GridColumnStyles )
         {
            Console::WriteLine( myColumnStyle->MappingName );
         }
      }
   }

private void AddTables(DataGrid myDataGrid, DataSet myDataSet){
   foreach(DataTable t in myDataSet.Tables){
      DataGridTableStyle myGridTableStyle = new 
      DataGridTableStyle();
      myGridTableStyle.MappingName = t.TableName;
      myDataGrid.TableStyles.Add(myGridTableStyle);

      /* Note that DataGridColumnStyle objects will
      be created automatically for the first DataGridTableStyle
      when you add it to the GridTableStylesCollection.*/
   }
}
private void PrintGridStyleInfo(DataGrid myDataGrid){
   /* Print the MappingName of each DataGridTableStyle,
   and the MappingName of each DataGridColumnStyle. */
   foreach(DataGridTableStyle myGridStyle in 
   myDataGrid.TableStyles){
   Console.WriteLine(myGridStyle.MappingName);
   foreach(DataGridColumnStyle myColumnStyle in 
      myGridStyle.GridColumnStyles){
  Console.WriteLine(myColumnStyle.MappingName);
      }
   }
}

Private Sub AddTables(myDataGrid As DataGrid, _
myDataSet As DataSet )
    Dim t As DataTable 
    For Each t in myDataSet.Tables
       Dim myGridTableStyle As DataGridTableStyle  = new _
       DataGridTableStyle()
       myGridTableStyle.MappingName = t.TableName
       myDataGrid.TableStyles.Add(myGridTableStyle)
       ' Note that DataGridColumnStyle objects will
       ' be created automatically for the first DataGridTableStyle
       ' when you add it to the GridTableStylesCollection.*/
    Next
 End Sub
 Private Sub PrintGridStyleInfo(myDataGrid As DataGrid )
    Dim myGridStyle As DataGridTableStyle
    Dim myColumnStyle As DataGridColumnStyle
    
    for each myGridStyle in _
    myDataGrid.TableStyles
       Console.WriteLine(myGridStyle.MappingName)
       for each myColumnStyle in myGridStyle.GridColumnStyles
      Console.WriteLine(myColumnStyle.MappingName)
       Next
    Next
 End Sub

Remarks

Use the GridTableStylesCollection retrieved through the TableStyles property to create customized views of each table displayed by the System.Windows.Forms.DataGrid control.

By default, the collection returned by TableStyles property does not contain any DataGridTableStyle objects. To create a set of customized views:

Create a DataGridTableStyle.
Set the MappingName of the grid table object to the TableName of the DataTable.
Add DataGridColumnStyle objects, one for each grid column you want to show, to the GridColumnStylesCollection returned by the GridColumnStyles property.
Set the MappingName of each DataGridColumnStyle to the ColumnName of a DataColumn.
Add the DataGridTableStyle object to the collection returned by TableStyles property.

Caution

Always create DataGridColumnStyle objects and add them to the GridColumnStylesCollection before adding DataGridTableStyle objects to the GridTableStylesCollection. When you add an empty DataGridTableStyle with a valid MappingName value to the collection, DataGridColumnStyle objects are automatically generated for you. Consequently, an exception will be thrown if you try to add new DataGridColumnStyle objects with duplicate MappingName values to the GridColumnStylesCollection.

Applies to

Jaa