GridTableStylesCollection Clase

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Source:

GridTableStylesCollection.cs

Precaución

DataGrid is provided for binary compatibility with .NET Framework and is not intended to be used directly from your code. Use DataGridView instead.

Representa una colección de DataGridTableStyle objetos en el DataGrid control .

public ref class GridTableStylesCollection : System::Windows::Forms::BaseCollection, System::Collections::IList

[System.ComponentModel.ListBindable(false)]
[System.ComponentModel.Browsable(false)]
[System.Obsolete("`DataGrid` is provided for binary compatibility with .NET Framework and is not intended to be used directly from your code. Use `DataGridView` instead.", false, DiagnosticId="WFDEV006", UrlFormat="https://aka.ms/winforms-warnings/{0}")]
public class GridTableStylesCollection : System.Windows.Forms.BaseCollection, System.Collections.IList

[<System.ComponentModel.ListBindable(false)>]
[<System.ComponentModel.Browsable(false)>]
[<System.Obsolete("`DataGrid` is provided for binary compatibility with .NET Framework and is not intended to be used directly from your code. Use `DataGridView` instead.", false, DiagnosticId="WFDEV006", UrlFormat="https://aka.ms/winforms-warnings/{0}")>]
type GridTableStylesCollection = class
    inherit BaseCollection
    interface IList
    interface ICollection
    interface IEnumerable

Public Class GridTableStylesCollection
Inherits BaseCollection
Implements IList

Herencia

Object

MarshalByRefObject

BaseCollection

GridTableStylesCollection

Atributos

ListBindableAttribute BrowsableAttribute ObsoleteAttribute

Implementaciones

ICollection IEnumerable IList

Ejemplos

En el ejemplo de código siguiente se crean dos DataGridTableStyle objetos y se agrega cada uno a la GridTableStylesCollection propiedad devuelta por la TableStyles propiedad de un 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 );
}

private void AddCustomDataTableStyle(){
   DataGridTableStyle ts1 = new 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 = new DataGridBoolColumn();
   boolCol.MappingName = "Current";
   boolCol.HeaderText = "IsCurrent Customer";
   boolCol.Width = 150;
   ts1.GridColumnStyles.Add(boolCol);
   
   // Add a second column style.
   DataGridColumnStyle TextCol = new DataGridTextBoxColumn();
   TextCol.MappingName = "custName";
   TextCol.HeaderText = "Customer Name";
   TextCol.Width = 250;
   ts1.GridColumnStyles.Add(TextCol);

   // Create the second table style with columns.
   DataGridTableStyle ts2 = new DataGridTableStyle();
   ts2.MappingName = "Orders";

   // Set other properties.
   ts2.AlternatingBackColor = Color.LightBlue;
   
   // Create new ColumnStyle objects.
   DataGridColumnStyle cOrderDate = 
   new 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 "c" specifies a currency format. */     
   DataGridColumnStyle csOrderAmount = 
   new 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);
}

Private Sub AddCustomDataTableStyle()
   Dim ts1 As New 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. 
     
   Dim boolCol As New DataGridBoolColumn()
   boolCol.MappingName = "Current"
   boolCol.HeaderText = "IsCurrent Customer"
   boolCol.Width = 150
   ts1.GridColumnStyles.Add(boolCol)
     
   ' Add a second column style.
   Dim TextCol As New DataGridTextBoxColumn()
   TextCol.MappingName = "custName"
   TextCol.HeaderText = "Customer Name"
   TextCol.Width = 250
   ts1.GridColumnStyles.Add(TextCol)
     
   ' Create the second table style with columns.
   Dim ts2 As New DataGridTableStyle()
   ts2.MappingName = "Orders"
     
   ' Set other properties.
   ts2.AlternatingBackColor = Color.LightBlue
     
   ' Create new ColumnStyle objects.
   Dim cOrderDate As New 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. 
   Dim pcol As System.ComponentModel.PropertyDescriptorCollection = _
   Me.BindingContext(myDataSet, "Customers.custToOrders"). _
   GetItemProperties()

   ' Create a formatted column using a PropertyDescriptor.
   ' The formatting character "c" specifies a currency format. */     
     
   Dim csOrderAmount As _
   New 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)
End Sub

Comentarios

GridTableStylesCollection contiene DataGridTableStyle objetos que permiten al DataGrid control mostrar un estilo de cuadrícula personalizado para cada DataTable uno de un DataSetobjeto .

En el DataGrid control , la TableStyles propiedad devuelve .GridTableStylesCollection

De forma predeterminada, GridTableStylesCollection no contiene ningún DataGridTableStyle objeto . En su lugar, DataGrid muestra cada tabla con la configuración predeterminada para el color, el ancho y el formato. Se muestran todas las columnas de cada tabla. Cuando se agrega un DataGridTableStyle objeto a la colección, DataGrid usa para MappingName determinar qué objeto proporciona los datos de la cuadrícula. Por ejemplo, si el origen de datos es un DataSet que contiene tres DataTable objetos, MappingName debe coincidir con el TableName de uno de los objetos . MappingName Si no coincide con ninguno de los TableName valores, se usará la configuración predeterminada para mostrar los datos de cada tabla y se omitirá la DataGridTableStyle configuración.

Precaución

DataGridColumnStyle Cree siempre objetos y agréguelos a GridColumnStylesCollection antes de agregar DataGridTableStyle objetos a GridTableStylesCollection. Al agregar un vacío DataGridTableStyle con un valor válido MappingName a la colección, DataGridColumnStyle los objetos se generan automáticamente. Por lo tanto, se producirá una excepción si intenta agregar nuevos DataGridColumnStyle objetos con valores duplicados MappingName a GridColumnStylesCollection. Como alternativa, borre el GridColumnStylesCollection uso del Clear método .

Propiedades

Nombre	Description
Count	Obsoletos. Obtiene el número total de elementos de la colección. (Heredado de BaseCollection)
IsReadOnly	Obsoletos. Obtiene un valor que indica si la colección es de solo lectura. (Heredado de BaseCollection)
IsSynchronized	Obsoletos. Obtiene un valor que indica si se sincroniza el acceso a .ICollection (Heredado de BaseCollection)
Item[Int32]	Obsoletos. Obtiene el DataGridTableStyle objeto especificado por índice.
Item[String]	Obsoletos. Obtiene con DataGridTableStyle el nombre especificado.
List	Obsoletos. Obtiene la lista de elementos contenidos en la BaseCollection instancia de . (Heredado de BaseCollection)
SyncRoot	Obsoletos. Obtiene un objeto que se puede usar para sincronizar el acceso a la BaseCollection. (Heredado de BaseCollection)

Métodos

Nombre	Description
Add(DataGridTableStyle)	Obsoletos. Agrega un DataGridTableStyle objeto a esta colección.
AddRange(DataGridTableStyle[])	Obsoletos. Agrega una matriz de estilos de tabla a la colección.
Clear()	Obsoletos. Borra la colección.
Contains(DataGridTableStyle)	Obsoletos. Obtiene un valor que indica si GridTableStylesCollection contiene el objeto especificado DataGridTableStyle.
Contains(String)	Obsoletos. Obtiene un valor que indica si GridTableStylesCollection contiene el DataGridTableStyle especificado por nombre.
CopyTo(Array, Int32)	Obsoletos. Copia todos los elementos de la unidimensional actual en la unidimensional ArrayArray especificada a partir del índice de destino Array especificado. (Heredado de BaseCollection)
GetEnumerator()	Obsoletos. Obtiene el objeto que permite recorrer en iteración los miembros de la colección. (Heredado de BaseCollection)
OnCollectionChanged(CollectionChangeEventArgs)	Obsoletos. Genera el evento CollectionChanged.
Remove(DataGridTableStyle)	Obsoletos. Quita el especificado DataGridTableStyle.
RemoveAt(Int32)	Obsoletos. Quita un DataGridTableStyle objeto en el índice especificado.

Eventos

Nombre	Description
CollectionChanged	Obsoletos. Se produce cuando la colección ha cambiado.

Implementaciones de interfaz explícitas

Nombre	Description
ICollection.CopyTo(Array, Int32)	Obsoletos. Copia la colección en una unidimensional Arraycompatible, empezando por el índice especificado de la matriz de destino.
ICollection.Count	Obsoletos. Obtiene el número de objetos de la colección.
ICollection.IsSynchronized	Obsoletos. Obtiene un valor que indica si el acceso a GridTableStylesCollection está sincronizado (seguro para subprocesos).
ICollection.SyncRoot	Obsoletos. Obtiene un objeto que se puede usar para sincronizar el acceso a la colección.
IEnumerable.GetEnumerator()	Obsoletos. Devuelve un enumerador para la colección.
IList.Add(Object)	Obsoletos. Agrega un DataGridTableStyle objeto a esta colección.
IList.Clear()	Obsoletos. Borra la colección.
IList.Contains(Object)	Obsoletos. Determina si un elemento está en la colección.
IList.IndexOf(Object)	Obsoletos. Devuelve el índice de base cero de la primera aparición del objeto especificado en la colección.
IList.Insert(Int32, Object)	Obsoletos. Implementa el Insert(Int32, Object) método . Siempre produce NotSupportedException.
IList.IsFixedSize	Obsoletos. Obtiene un valor que indica si la colección tiene un tamaño fijo.
IList.IsReadOnly	Obsoletos. Obtiene un valor que indica si la colección es de solo lectura.
IList.Item[Int32]	Obsoletos. Obtiene o establece el elemento en el índice especificado.
IList.Remove(Object)	Obsoletos. Quita el especificado DataGridTableStyle.
IList.RemoveAt(Int32)	Obsoletos. Quita el DataGridColumnStyle objeto con el índice especificado de la colección.

Consulte también

• DataGrid
• GridColumnStyles