Export (0) Print
Expand All

DataGridViewColumnCollection Class

Represents a collection of DataGridViewColumn objects in a DataGridView control.

System.Object
  System.MarshalByRefObject
    System.Windows.Forms.BaseCollection
      System.Windows.Forms.DataGridViewColumnCollection

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

[ListBindableAttribute(false)]
public class DataGridViewColumnCollection : BaseCollection, 
	IList, ICollection, IEnumerable

The DataGridViewColumnCollection type exposes the following members.

  NameDescription
Public methodDataGridViewColumnCollectionInitializes a new instance of the DataGridViewColumnCollection class for the given DataGridView.
Top

  NameDescription
Public propertyCountGets the total number of elements in the collection. (Inherited from BaseCollection.)
Protected propertyDataGridViewGets the DataGridView upon which the collection performs column-related operations.
Public propertyIsReadOnlyGets a value indicating whether the collection is read-only. (Inherited from BaseCollection.)
Public propertyIsSynchronizedGets a value indicating whether access to the ICollection is synchronized. (Inherited from BaseCollection.)
Public propertyItem[Int32]Gets or sets the column at the given index in the collection.
Public propertyItem[String]Gets or sets the column of the given name in the collection.
Protected propertyListGets the list of elements contained in the BaseCollection instance. (Overrides BaseCollection.List.)
Public propertySyncRootGets an object that can be used to synchronize access to the BaseCollection. (Inherited from BaseCollection.)
Top

  NameDescription
Public methodAdd(DataGridViewColumn)Adds the given column to the collection.
Public methodAdd(String, String)Adds a DataGridViewTextBoxColumn with the given column name and column header text to the collection.
Public methodAddRangeAdds a range of columns to the collection.
Public methodClearClears the collection.
Public methodContains(DataGridViewColumn)Determines whether the collection contains the given column.
Public methodContains(String)Determines whether the collection contains the column referred to by the given name.
Public methodCopyTo(Array, Int32)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.)
Public methodCopyTo(DataGridViewColumn[], Int32)Copies the items from the collection to the given array.
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 methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetColumnCountReturns the number of columns that meet the given filter requirements.
Public methodGetColumnsWidthReturns the width, in pixels, required to display all of the columns that meet the given filter requirements.
Public methodGetEnumeratorGets the object that enables iterating through the members of the collection. (Inherited from BaseCollection.)
Public methodGetFirstColumn(DataGridViewElementStates)Returns the first column in display order that meets the given inclusion-filter requirements.
Public methodGetFirstColumn(DataGridViewElementStates, DataGridViewElementStates)Returns the first column in display order that meets the given inclusion-filter and exclusion-filter requirements.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLastColumnReturns the last column in display order that meets the given filter requirements.
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetNextColumnGets the first column after the given column in display order that meets the given filter requirements.
Public methodGetPreviousColumnGets the last column prior to the given column in display order that meets the given filter requirements.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfGets the index of the given DataGridViewColumn in the collection.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodInsertInserts a column at the given index in the collection.
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 methodOnCollectionChangedRaises the CollectionChanged event.
Public methodRemove(DataGridViewColumn)Removes the specified column from the collection.
Public methodRemove(String)Removes the column with the specified name from the collection.
Public methodRemoveAtRemoves the column at the given index in the collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventCollectionChangedOccurs when the collection changes.
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToInfrastructure. Copies the entire contents of the collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Explicit interface implemetationPrivate propertyICollection.CountInfrastructure. Gets the number of elements in the collection.
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedInfrastructure. Gets a value indicating whether access to the collection is synchronized.
Explicit interface implemetationPrivate propertyICollection.SyncRootInfrastructure. Gets an object that can be used to synchronize access to the collection.
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorInfrastructure. Returns an enumerator that iterates through the collection.
Explicit interface implemetationPrivate methodIList.AddInfrastructure. Adds an object to the end of the collection.
Explicit interface implemetationPrivate methodIList.ClearInfrastructure. Removes all elements from the collection.
Explicit interface implemetationPrivate methodIList.ContainsInfrastructure. Determines whether an object is in the collection.
Explicit interface implemetationPrivate methodIList.IndexOfInfrastructure. Determines the index of a specific item in the collection.
Explicit interface implemetationPrivate methodIList.InsertInfrastructure. Inserts an element into the collection at the specified index.
Explicit interface implemetationPrivate propertyIList.IsFixedSizeInfrastructure. Gets a value indicating whether the collection has a fixed size.
Explicit interface implemetationPrivate propertyIList.IsReadOnlyInfrastructure. Gets a value indicating whether the collection is read-only.
Explicit interface implemetationPrivate propertyIList.ItemInfrastructure. Gets or sets the element at the specified index.
Explicit interface implemetationPrivate methodIList.RemoveInfrastructure. Removes the first occurrence of the specified object from the collection.
Explicit interface implemetationPrivate methodIList.RemoveAtInfrastructure. Removes the element with the specified index from the collection.
Top

You can retrieve an instance of this class through the Columns property of the DataGridView control. The collection maintains a reference to the control through the DataGridView property.

The following code example illustrates the use of this type.


private DataGridView dataGridView1 = new DataGridView();

private void AddColorColumn()
{
    DataGridViewComboBoxColumn comboBoxColumn =
        new DataGridViewComboBoxColumn();
    comboBoxColumn.Items.AddRange(
        Color.Red, Color.Yellow, Color.Green, Color.Blue);
    comboBoxColumn.ValueType = typeof(Color);
    dataGridView1.Columns.Add(comboBoxColumn);
    dataGridView1.EditingControlShowing +=
        new DataGridViewEditingControlShowingEventHandler(
        dataGridView1_EditingControlShowing);
}

private void dataGridView1_EditingControlShowing(object sender,
    DataGridViewEditingControlShowingEventArgs e)
{
    ComboBox combo = e.Control as ComboBox;
    if (combo != null)
    {
        // Remove an existing event-handler, if present, to avoid 
        // adding multiple handlers when the editing control is reused.
        combo.SelectedIndexChanged -=
            new EventHandler(ComboBox_SelectedIndexChanged);

        // Add the event handler. 
        combo.SelectedIndexChanged +=
            new EventHandler(ComboBox_SelectedIndexChanged);
    }
}

private void ComboBox_SelectedIndexChanged(object sender, EventArgs e)
{
    ((ComboBox)sender).BackColor = (Color)((ComboBox)sender).SelectedItem;
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.

Community Additions

ADD
Show:
© 2014 Microsoft