GridTableStylesCollection Class
Represents a collection of DataGridTableStyle objects in the DataGrid control.
System::MarshalByRefObject
System.Windows.Forms::BaseCollection
System.Windows.Forms::GridTableStylesCollection
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The GridTableStylesCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Count | Gets the total number of elements in the collection. (Inherited from BaseCollection.) |
![]() | IsReadOnly | Gets a value indicating whether the collection is read-only. (Inherited from BaseCollection.) |
![]() | IsSynchronized | Gets a value indicating whether access to the ICollection is synchronized. (Inherited from BaseCollection.) |
![]() | Item[Int32] | Gets the DataGridTableStyle specified by index. |
![]() | Item[String] | Gets the DataGridTableStyle with the specified name. |
![]() | List | Gets the underlying list. (Overrides BaseCollection::List.) |
![]() | SyncRoot | Gets an object that can be used to synchronize access to the BaseCollection. (Inherited from BaseCollection.) |
| Name | Description | |
|---|---|---|
![]() | Add | Adds a DataGridTableStyle to this collection. |
![]() | AddRange | Adds an array of table styles to the collection. |
![]() | Clear | Clears the collection. |
![]() | Contains(DataGridTableStyle) | Gets a value indicating whether the GridTableStylesCollection contains the specified DataGridTableStyle. |
![]() | Contains(String) | Gets a value indicating whether the GridTableStylesCollection contains the DataGridTableStyle specified by name. |
![]() | CopyTo | Copies all the elements of the current one-dimensional Array to the specified one-dimensional Array starting at the specified destination Array index. (Inherited from BaseCollection.) |
![]() | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetEnumerator | Gets the object that enables iterating through the members of the collection. (Inherited from BaseCollection.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() | OnCollectionChanged | Raises the CollectionChanged event. |
![]() | Remove | Removes the specified DataGridTableStyle. |
![]() | RemoveAt | Removes a DataGridTableStyle at the specified index. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() | AsParallel | Enables parallelization of a query. (Defined by ParallelEnumerable.) |
![]() | AsQueryable | Converts an IEnumerable to an IQueryable. (Defined by Queryable.) |
![]() | Cast<TResult> | Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.) |
![]() | OfType<TResult> | Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICollection::CopyTo | Infrastructure. Copies the collection to a compatible one-dimensional Array, starting at the specified index of the target array. |
![]() ![]() | ICollection::Count | Infrastructure. Gets the number of items in the collection. |
![]() ![]() | ICollection::IsSynchronized | Infrastructure. Gets a value indicating whether access to the GridTableStylesCollection is synchronized (thread safe). |
![]() ![]() | ICollection::SyncRoot | Infrastructure. Gets an object that can be used to synchronize access to the collection. |
![]() ![]() | IEnumerable::GetEnumerator | Infrastructure. Returns an enumerator for the collection. |
![]() ![]() | IList::Add | Infrastructure. Adds a DataGridTableStyle to this collection. |
![]() ![]() | IList::Clear | Infrastructure. Clears the collection. |
![]() ![]() | IList::Contains | Infrastructure. Determines whether an element is in the collection. |
![]() ![]() | IList::IndexOf | Infrastructure. Returns the zero-based index of the first occurrence of the specified object in the collection. |
![]() ![]() | IList::Insert | Infrastructure. Implements the Insert method. Always throws NotSupportedException. |
![]() ![]() | IList::IsFixedSize | Infrastructure. Gets a value indicating whether the collection has a fixed size. |
![]() ![]() | IList::IsReadOnly | Infrastructure. Gets a value indicating whether the collection is read-only. |
![]() ![]() | IList::Item | Infrastructure. Gets or sets the element at the specified index. |
![]() ![]() | IList::Remove | Infrastructure. Removes the specified DataGridTableStyle. |
![]() ![]() | IList::RemoveAt | Infrastructure. Removes the DataGridColumnStyle with the specified index from the collection. |
The GridTableStylesCollection contains DataGridTableStyle objects that allows the DataGrid control to display a customized grid style for each DataTable in a DataSet.
On the DataGrid control, the TableStyles property returns the GridTableStylesCollection.
By default, the GridTableStylesCollection does not contain any DataGridTableStyle objects. Instead, the DataGrid displays each table using default settings for color, width, and formatting. All columns of each table are displayed. When a DataGridTableStyle is added to the collection, the DataGrid uses the MappingName to determine which object supplies the data for the grid. For example, if the data source is a DataSet that contains three DataTable objects, the MappingName must match the TableName of one of the objects. If the MappingName does not match any of the TableName values, the default settings will be used to display data for each table, and the DataGridTableStyle settings will be ignored.
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. Alternatively, clear the GridColumnStylesCollection using the Clear method. |
The following code example creates two DataGridTableStyle objects and adds each to the GridTableStylesCollection returned by the TableStyles property of a DataGrid control.
void AddCustomDataTableStyle() { DataGridTableStyle^ ts1 = gcnew DataGridTableStyle; ts1->MappingName = "Customers"; // Set other properties. ts1->AlternatingBackColor = Color::LightGray; /* Add a GridColumnStyle and set its MappingName to the name of a DataColumn in the DataTable. Set the HeaderText and Width properties. */ DataGridColumnStyle^ boolCol = gcnew DataGridBoolColumn; boolCol->MappingName = "Current"; boolCol->HeaderText = "IsCurrent Customer"; boolCol->Width = 150; ts1->GridColumnStyles->Add( boolCol ); // Add a second column style. DataGridColumnStyle^ TextCol = gcnew DataGridTextBoxColumn; TextCol->MappingName = "custName"; TextCol->HeaderText = "Customer Name"; TextCol->Width = 250; ts1->GridColumnStyles->Add( TextCol ); // Create the second table style with columns. DataGridTableStyle^ ts2 = gcnew DataGridTableStyle; ts2->MappingName = "Orders"; // Set other properties. ts2->AlternatingBackColor = Color::LightBlue; // Create new ColumnStyle objects. DataGridColumnStyle^ cOrderDate = gcnew DataGridTextBoxColumn; cOrderDate->MappingName = "OrderDate"; cOrderDate->HeaderText = "Order Date"; cOrderDate->Width = 100; ts2->GridColumnStyles->Add( cOrderDate ); /*Use a PropertyDescriptor to create a formatted column. First get the PropertyDescriptorCollection for the data source and data member. */ System::ComponentModel::PropertyDescriptorCollection^ pcol = this-> BindingContext[myDataSet, "Customers::custToOrders"]-> GetItemProperties(); /* Create a formatted column using a PropertyDescriptor. The formatting character S"c" specifies a currency format. */ DataGridColumnStyle^ csOrderAmount = gcnew DataGridTextBoxColumn( pcol[ "OrderAmount" ],"c",true ); csOrderAmount->MappingName = "OrderAmount"; csOrderAmount->HeaderText = "Total"; csOrderAmount->Width = 100; ts2->GridColumnStyles->Add( csOrderAmount ); /* Add the DataGridTableStyle instances to the GridTableStylesCollection. */ myDataGrid->TableStyles->Add( ts1 ); myDataGrid->TableStyles->Add( ts2 ); }
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.

