GridTableStylesCollection Класс

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

GridTableStylesCollection.cs

Внимание

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

Представляет коллекцию DataGridTableStyle объектов в элементе DataGrid управления.

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

Наследование

Object

MarshalByRefObject

BaseCollection

GridTableStylesCollection

Атрибуты

ListBindableAttribute BrowsableAttribute ObsoleteAttribute

Реализации

ICollection IEnumerable IList

Примеры

В следующем примере кода создаются два DataGridTableStyle объекта и добавляются каждый из GridTableStylesCollection возвращаемых TableStyles свойством DataGrid элемента управления.

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

Комментарии

DataGridTableStyle Содержит GridTableStylesCollection объекты, позволяющие DataGrid элементу управления отображать настраиваемый стиль сетки для каждой DataTableDataSetиз них.

В элементе DataGrid управления TableStyles свойство возвращает GridTableStylesCollectionзначение .

По умолчанию объект GridTableStylesCollection не содержит DataGridTableStyle объектов. Вместо этого в каждой DataGrid таблице отображаются параметры по умолчанию для цвета, ширины и форматирования. Отображаются все столбцы каждой таблицы. При добавлении в DataGridTableStyle коллекцию DataGrid используется MappingName для определения того, какой объект предоставляет данные для сетки. Например, если источник данных является DataSet источником данных, который содержит три DataTable объекта, MappingName он должен соответствовать TableName одному из объектов. MappingName Если значения не совпадаютTableName, параметры по умолчанию будут использоваться для отображения данных для каждой таблицы, а DataGridTableStyle параметры будут игнорироваться.

Предостережение

Всегда создавайте объекты и добавляйте DataGridColumnStyle их в GridColumnStylesCollection него перед добавлением GridTableStylesCollectionDataGridTableStyle объектов. При добавлении пустого DataGridTableStyleMappingName значения в коллекцию DataGridColumnStyle объекты создаются автоматически. Следовательно, при попытке добавить новые DataGridColumnStyle объекты с повторяющимися MappingName значениями в объект GridColumnStylesCollectionбудет возникать исключение. Кроме того, очистите GridColumnStylesCollection метод с помощью Clear метода.

Свойства

Имя	Описание
Count	Устаревшие.. Возвращает общее количество элементов в коллекции. (Унаследовано от BaseCollection)
IsReadOnly	Устаревшие.. Возвращает значение, указывающее, доступна ли коллекция только для чтения. (Унаследовано от BaseCollection)
IsSynchronized	Устаревшие.. Возвращает значение, указывающее, синхронизирован ли доступ к ней ICollection . (Унаследовано от BaseCollection)
Item[Int32]	Устаревшие.. Возвращает заданный DataGridTableStyle индексом.
Item[String]	Устаревшие.. Возвращает указанное DataGridTableStyle имя.
List	Устаревшие.. Возвращает список элементов, содержащихся в экземпляре BaseCollection . (Унаследовано от BaseCollection)
SyncRoot	Устаревшие.. Получает объект, который можно использовать для синхронизации доступа к объекту BaseCollection. (Унаследовано от BaseCollection)

Методы

Имя	Описание
Add(DataGridTableStyle)	Устаревшие.. Добавляет в DataGridTableStyle эту коллекцию.
AddRange(DataGridTableStyle[])	Устаревшие.. Добавляет массив стилей таблиц в коллекцию.
Clear()	Устаревшие.. Очищает коллекцию.
Contains(DataGridTableStyle)	Устаревшие.. Возвращает значение, указывающее, содержит ли GridTableStylesCollection указанный объект DataGridTableStyle.
Contains(String)	Устаревшие.. Возвращает значение, указывающее, содержит ли GridTableStylesCollection он указанный DataGridTableStyle по имени.
CopyTo(Array, Int32)	Устаревшие.. Копирует все элементы текущего одномерного в указанный одномерный ArrayArray индекс, начиная с указанного целевого Array индекса. (Унаследовано от BaseCollection)
GetEnumerator()	Устаревшие.. Возвращает объект, который позволяет выполнять итерацию между элементами коллекции. (Унаследовано от BaseCollection)
OnCollectionChanged(CollectionChangeEventArgs)	Устаревшие.. Вызывает событие CollectionChanged.
Remove(DataGridTableStyle)	Устаревшие.. Удаляет указанный DataGridTableStyleобъект.
RemoveAt(Int32)	Устаревшие.. Удаляется DataGridTableStyle по указанному индексу.

События

Имя	Описание
CollectionChanged	Устаревшие.. Происходит при изменении коллекции.

Явные реализации интерфейса

Имя	Описание
ICollection.CopyTo(Array, Int32)	Устаревшие.. Копирует коллекцию в совместимую одномерную, Arrayначиная с указанного индекса целевого массива.
ICollection.Count	Устаревшие.. Возвращает число элементов в коллекции.
ICollection.IsSynchronized	Устаревшие.. Возвращает значение, указывающее, синхронизирован ли доступ к GridTableStylesCollection синхронизированному (потокобезопасно).
ICollection.SyncRoot	Устаревшие.. Возвращает объект, который можно использовать для синхронизации доступа к коллекции.
IEnumerable.GetEnumerator()	Устаревшие.. Возвращает перечислитель для коллекции.
IList.Add(Object)	Устаревшие.. Добавляет в DataGridTableStyle эту коллекцию.
IList.Clear()	Устаревшие.. Очищает коллекцию.
IList.Contains(Object)	Устаревшие.. Определяет, находится ли элемент в коллекции.
IList.IndexOf(Object)	Устаревшие.. Возвращает отсчитываемый от нуля индекс первого вхождения указанного объекта в коллекции.
IList.Insert(Int32, Object)	Устаревшие.. Insert(Int32, Object) Реализует метод. Всегда бросает NotSupportedException.
IList.IsFixedSize	Устаревшие.. Возвращает значение, указывающее, имеет ли коллекция фиксированный размер.
IList.IsReadOnly	Устаревшие.. Возвращает значение, указывающее, доступна ли коллекция только для чтения.
IList.Item[Int32]	Устаревшие.. Возвращает или задает элемент по указанному индексу.
IList.Remove(Object)	Устаревшие.. Удаляет указанный DataGridTableStyleобъект.
IList.RemoveAt(Int32)	Устаревшие.. Удаляет DataGridColumnStyle указанный индекс из коллекции.

См. также раздел

• DataGrid
• GridColumnStyles