This documentation is archived and is not being maintained.

DataGridTableStyle Class

Represents the table drawn by the System.Windows.Forms.DataGrid control at run time.


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

public class DataGridTableStyle : Component, 

The DataGridTableStyle type exposes the following members.

Public methodDataGridTableStyle()Initializes a new instance of the DataGridTableStyle class.
Public methodDataGridTableStyle(Boolean)Infrastructure. Initializes a new instance of the DataGridTableStyle class using the specified value to determine whether the grid table is the default style.
Public methodDataGridTableStyle(CurrencyManager)Initializes a new instance of the DataGridTableStyle class with the specified CurrencyManager.

Public propertyAllowSortingIndicates whether sorting is allowed on the grid table when this DataGridTableStyle is used.
Public propertyAlternatingBackColorGets or sets the background color of odd-numbered rows of the grid.
Public propertyBackColorGets or sets the background color of even-numbered rows of the grid.
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyColumnHeadersVisibleGets or sets a value indicating whether column headers are visible.
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyDataGridGets or sets the System.Windows.Forms.DataGrid control for the drawn table.
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyForeColorGets or sets the foreground color of the grid table.
Public propertyGridColumnStylesGets the collection of columns drawn for this table.
Public propertyGridLineColorGets or sets the color of grid lines.
Public propertyGridLineStyleGets or sets the style of grid lines.
Public propertyHeaderBackColorGets or sets the background color of headers.
Public propertyHeaderFontGets or sets the font used for header captions.
Public propertyHeaderForeColorGets or sets the foreground color of headers.
Public propertyLinkColorGets or sets the color of link text.
Public propertyLinkHoverColorInfrastructure. Gets or sets the color displayed when hovering over link text.
Public propertyMappingNameGets or sets the name used to map this table to a specific data source.
Public propertyPreferredColumnWidthGets or sets the width used to create columns when a new grid is displayed.
Public propertyPreferredRowHeightGets or sets the height used to create a row when a new grid is displayed.
Public propertyReadOnlyGets or sets a value indicating whether columns can be edited.
Public propertyRowHeadersVisibleGets or sets a value indicating whether row headers are visible.
Public propertyRowHeaderWidthGets or sets the width of row headers.
Public propertySelectionBackColorGets or sets the background color of selected cells.
Public propertySelectionForeColorGets or sets the foreground color of selected cells.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)

Public methodBeginEditRequests an edit operation.
Protected methodCreateGridColumn(PropertyDescriptor)Creates a DataGridColumnStyle, using the specified property descriptor.
Protected methodCreateGridColumn(PropertyDescriptor, Boolean)Creates a DataGridColumnStyle using the specified property descriptor. Specifies whether the DataGridColumnStyle is a default column style.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Disposes of the resources (other than memory) used by the DataGridTableStyle. (Overrides Component.Dispose(Boolean).)
Public methodEndEditRequests an end to an edit operation.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodOnAllowSortingChangedRaises the AllowSortingChanged event.
Protected methodOnAlternatingBackColorChangedRaises the AlternatingBackColorChanged event.
Protected methodOnBackColorChangedRaises the BackColorChanged event.
Protected methodOnColumnHeadersVisibleChangedRaises the ColumnHeadersVisibleChanged event.
Protected methodOnForeColorChangedRaises the ForeColorChanged event.
Protected methodOnGridLineColorChangedRaises the GridLineColorChanged event.
Protected methodOnGridLineStyleChangedRaises the GridLineStyleChanged event.
Protected methodOnHeaderBackColorChangedRaises the HeaderBackColorChanged event.
Protected methodOnHeaderFontChangedRaises the HeaderFontChanged event.
Protected methodOnHeaderForeColorChangedRaises the HeaderForeColorChanged event.
Protected methodOnLinkColorChangedRaises the LinkColorChanged event.
Protected methodOnLinkHoverColorChangedRaises the LinkHoverColorChanged event.
Protected methodOnMappingNameChangedRaises the MappingNameChanged event
Protected methodOnPreferredColumnWidthChangedRaises the PreferredColumnWidthChanged event.
Protected methodOnPreferredRowHeightChangedRaises the PreferredRowHeightChanged event.
Protected methodOnReadOnlyChangedRaises the ReadOnlyChanged event.
Protected methodOnRowHeadersVisibleChangedRaises the RowHeadersVisibleChanged event.
Protected methodOnRowHeaderWidthChangedRaises the RowHeaderWidthChanged event.
Protected methodOnSelectionBackColorChangedRaises the SelectionBackColorChanged event.
Protected methodOnSelectionForeColorChangedRaises the SelectionForeColorChanged event.
Public methodResetAlternatingBackColorResets the AlternatingBackColor property to its default value.
Public methodResetBackColorResets the BackColor property to its default value.
Public methodResetForeColorResets the ForeColor property to its default value.
Public methodResetGridLineColorResets the GridLineColor property to its default value.
Public methodResetHeaderBackColorResets the HeaderBackColor property to its default value.
Public methodResetHeaderFontResets the HeaderFont property to its default value.
Public methodResetHeaderForeColorResets the HeaderForeColor property to its default value.
Public methodResetLinkColorResets the LinkColor property to its default value.
Public methodResetLinkHoverColorInfrastructure. Resets the LinkHoverColor property to its default value.
Public methodResetSelectionBackColorResets the SelectionBackColor property to its default value.
Public methodResetSelectionForeColorResets the SelectionForeColor property to its default value.
Protected methodShouldSerializeAlternatingBackColorIndicates whether the AlternatingBackColor property should be persisted.
Protected methodShouldSerializeBackColorIndicates whether the BackColor property should be persisted.
Protected methodShouldSerializeForeColorIndicates whether the ForeColor property should be persisted.
Protected methodShouldSerializeGridLineColorIndicates whether the GridLineColor property should be persisted.
Protected methodShouldSerializeHeaderBackColorIndicates whether the HeaderBackColor property should be persisted.
Protected methodShouldSerializeHeaderForeColorIndicates whether the HeaderForeColor property should be persisted.
Protected methodShouldSerializeLinkColorIndicates whether the LinkColor property should be persisted.
Protected methodShouldSerializeLinkHoverColorInfrastructure. Indicates whether the LinkHoverColor property should be persisted.
Protected methodShouldSerializePreferredRowHeightIndicates whether the PreferredRowHeight property should be persisted.
Protected methodShouldSerializeSelectionBackColorIndicates whether the SelectionBackColor property should be persisted.
Protected methodShouldSerializeSelectionForeColorIndicates whether the SelectionForeColor property should be persisted.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Public eventAllowSortingChangedOccurs when the AllowSorting property value changes.
Public eventAlternatingBackColorChangedOccurs when the AlternatingBackColor value changes.
Public eventBackColorChangedOccurs when the BackColor value changes.
Public eventColumnHeadersVisibleChangedOccurs when the ColumnHeadersVisible value changes.
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventForeColorChangedOccurs when the ForeColor value changes.
Public eventGridLineColorChangedOccurs when the GridLineColor value changes.
Public eventGridLineStyleChangedOccurs when the GridLineStyle value changes.
Public eventHeaderBackColorChangedOccurs when the HeaderBackColor value changes.
Public eventHeaderFontChangedOccurs when the HeaderFont value changes.
Public eventHeaderForeColorChangedOccurs when the HeaderForeColor value changes.
Public eventLinkColorChangedOccurs when the LinkColor value changes.
Public eventLinkHoverColorChangedInfrastructure. Occurs when the LinkHoverColor value changes.
Public eventMappingNameChangedOccurs when the MappingName value changes.
Public eventPreferredColumnWidthChangedOccurs when the PreferredColumnWidth property value changes.
Public eventPreferredRowHeightChangedOccurs when the PreferredRowHeight value changes.
Public eventReadOnlyChangedOccurs when the ReadOnly value changes.
Public eventRowHeadersVisibleChangedOccurs when the RowHeadersVisible value changes.
Public eventRowHeaderWidthChangedOccurs when the RowHeaderWidth value changes.
Public eventSelectionBackColorChangedOccurs when the SelectionBackColor value changes.
Public eventSelectionForeColorChangedOccurs when the SelectionForeColor value changes.

Public fieldStatic memberDefaultTableStyleInfrastructure. Gets the default table style.

The System.Windows.Forms.DataGrid control displays data in the form of a grid. The DataGridTableStyle is a class that represents the drawn grid only. This grid should not be confused with the DataTable class, which is a possible source of data for the grid. Instead, the DataGridTableStyle strictly represents the grid as it is painted in the control. Therefore, through the DataGridTableStyle you can control the appearance of the grid for each DataTable. To specify which DataGridTableStyle is used when displaying data from a particular DataTable, set the MappingName to the TableName of a DataTable.

The GridTableStylesCollection retrieved through the TableStyles property contains all the DataGridTableStyle objects used by a System.Windows.Forms.DataGrid control. The collection can contain as many DataGridTableStyle objects as you need, however the MappingName of each must be unique. At run time, this allows you to substitute a different DataGridTableStyle for the same data, depending on the user's preference. To do this:

  1. Populate the GridTableStylesCollection with DataGridTableStyle objects. If a DataGridTableStyle exists in the GridTableStylesCollection whose MappingName property value equals the DataTable object's TableName property, the DataTable is displayed with this DataGridTableStyle. If no DataGridTableStyle exists with a matching MappingName, the DataTable is displayed with the default style for data grid tables.

  2. When a different grid style is needed, use the Item property to select the appropriate DataGridTableStyle (pass the TableName to the Item property) and set the MappingName of the returned object to a new value.

  3. Use the Item property to select the desired DataGridTableStyle, and set its MappingName to the TableName of the DataTable.

Caution noteCaution

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.

To determine which DataGridTableStyle is currently displayed, use the DataSource and DataMember properties of the System.Windows.Forms.DataGrid to return a CurrencyManager. If the data source implements the ITypedList interface, you can use the GetListName method to return the MappingName of the current table. This is shown in the C# code below:

 private void PrintCurrentListName(DataGrid myDataGrid){
  CurrencyManager myCM = (CurrencyManager)
  BindingContext[myDataGrid.DataSource, myDataGrid.DataMember];
  IList myList = myCM.List;
  ITypedList thisList = (ITypedList) myList;

If the DataSet contains DataTable objects related through DataRelation objects, and the currently displayed DataTable is a child table, the DataMember will return a string in the form of TableName.RelationName (in the simplest case). If the DataTable is further down in the hierarchy, the string will consist of the parent table's name followed by the necessary RelationName values required to reach the table's level. For example, imagine three DataTable objects in a hierarchical relationship named (top to bottom) Regions, Customers, and Orders, and two DataRelation objects named RegionsToCustomers and CustomersToOrders, the DataMember property will return "Regions.RegionsToCustomers.CustomersToOrders". However, the MappingName will then be "Orders".

The collection of DataGridTableStyle objects is returned through the TableStyles property of the System.Windows.Forms.DataGrid.

When a DataGridTableStyle is displayed, the settings for the DataGridTableStyle will override the settings for the System.Windows.Forms.DataGrid control. If a value is not set for a particular DataGridTableStyle property, the System.Windows.Forms.DataGrid control's value will be used instead. The following list shows the DataGridColumnStyle properties that can be set to override System.Windows.Forms.DataGrid control properties:

To bind the DataGrid to a strongly typed array of objects, the object type must contain public properties. To create a DataGridTableStyle that displays the array, set the DataGridTableStyle.MappingName property to typename where typename is replaced by the name of the object type. Also note that the MappingName property is case-sensitive; the type name must be matched exactly. See the MappingName property for an example.

You can also bind the DataGrid to an ArrayList. A feature of the ArrayList is that it can contain objects of multiple types, but the DataGrid can only bind to such a list when all items in the list are of the same type as the first item. This means that all objects must either be of the same type, or they must inherit from the same class as the first item in the list. For example, if the first item in a list is a Control, the second item could be a TextBox (which inherits from Control). If, on the other hand, the first item is a TextBox, the second object cannot be a Control. Further, the ArrayList must have items in it when it is bound and the objects in the DataGridTableStyle must contain public properties. An empty ArrayList will result in an empty grid. When binding to an ArrayList, set the MappingName of the DataGridTableStyle to "ArrayList" (the type name).

The following code example creates two DataGridTableStyle instances and sets the MappingName of each object to the TableName of a DataTable in a DataSet. The example then adds DataGridColumnStyle objects to the GridColumnStylesCollection of each DataGridTableStyle. For an example that runs, see the System.Windows.Forms.DataGrid example.

private void AddCustomDataTableStyle()
      /* Create a new DataGridTableStyle and set
      its MappingName to the TableName of a DataTable. */
      DataGridTableStyle ts1 = new DataGridTableStyle();
      ts1.MappingName = "Customers";

      /* Add a GridColumnStyle and set its MappingName 
      to the name of a DataColumn in the DataTable. 
      Set the HeaderText and Width properties. */

      DataGridColumnStyle boolCol = new DataGridBoolColumn();
      boolCol.MappingName = "Current";
      boolCol.HeaderText = "IsCurrent Customer";
      boolCol.Width = 150;

      // Add a second column style.
      DataGridColumnStyle TextCol = new DataGridTextBoxColumn();
      TextCol.MappingName = "custName";
      TextCol.HeaderText = "Customer Name";
      TextCol.Width = 250;

      // Create the second table style with columns.
      DataGridTableStyle ts2 = new DataGridTableStyle();
      ts2.MappingName = "Orders";
      // Change the colors.
      ts2.ForeColor = Color.Yellow;
      ts2.AlternatingBackColor = Color.Blue;
      ts2.BackColor = Color.Blue;

      // Create new DataGridColumnStyle objects.
      DataGridColumnStyle cOrderDate = 
      new DataGridTextBoxColumn();
      cOrderDate.MappingName = "OrderDate";
      cOrderDate.HeaderText = "Order Date";
      cOrderDate.Width = 100;

      PropertyDescriptorCollection pcol = this.BindingContext
      [myDataSet, "Customers.custToOrders"].GetItemProperties();

      DataGridColumnStyle csOrderAmount = 
      new DataGridTextBoxColumn(pcol["OrderAmount"], "c", true);
      csOrderAmount.MappingName = "OrderAmount";
      csOrderAmount.HeaderText = "Total";
      csOrderAmount.Width = 100;

      // Add the DataGridTableStyle objects to the collection.

.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.