This topic has not yet been rated - Rate this topic

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.

  Name Description
Public method DataGridViewColumnCollection Initializes a new instance of the DataGridViewColumnCollection class for the given DataGridView.
Top
  Name Description
Public property Count Gets the total number of elements in the collection. (Inherited from BaseCollection.)
Protected property DataGridView Gets the DataGridView upon which the collection performs column-related operations.
Public property IsReadOnly Gets a value indicating whether the collection is read-only. (Inherited from BaseCollection.)
Public property IsSynchronized Gets a value indicating whether access to the ICollection is synchronized. (Inherited from BaseCollection.)
Public property Item[Int32] Gets or sets the column at the given index in the collection.
Public property Item[String] Gets or sets the column of the given name in the collection.
Protected property List Gets the list of elements contained in the BaseCollection instance. (Overrides BaseCollection.List.)
Public property SyncRoot Gets an object that can be used to synchronize access to the BaseCollection. (Inherited from BaseCollection.)
Top
  Name Description
Public method Add(DataGridViewColumn) Adds the given column to the collection.
Public method Add(String, String) Adds a DataGridViewTextBoxColumn with the given column name and column header text to the collection.
Public method AddRange Adds a range of columns to the collection.
Public method Clear Clears the collection.
Public method Contains(DataGridViewColumn) Determines whether the collection contains the given column.
Public method Contains(String) Determines whether the collection contains the column referred to by the given name.
Public method CopyTo(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 method CopyTo(DataGridViewColumn[], Int32) Copies the items from the collection to the given array.
Public method 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.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetColumnCount Returns the number of columns that meet the given filter requirements.
Public method GetColumnsWidth Returns the width, in pixels, required to display all of the columns that meet the given filter requirements.
Public method GetEnumerator Gets the object that enables iterating through the members of the collection. (Inherited from BaseCollection.)
Public method GetFirstColumn(DataGridViewElementStates) Returns the first column in display order that meets the given inclusion-filter requirements.
Public method GetFirstColumn(DataGridViewElementStates, DataGridViewElementStates) Returns the first column in display order that meets the given inclusion-filter and exclusion-filter requirements.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLastColumn Returns the last column in display order that meets the given filter requirements.
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetNextColumn Gets the first column after the given column in display order that meets the given filter requirements.
Public method GetPreviousColumn Gets the last column prior to the given column in display order that meets the given filter requirements.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Gets the index of the given DataGridViewColumn in the collection.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Insert Inserts a column at the given index in the collection.
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnCollectionChanged Raises the CollectionChanged event.
Public method Remove(DataGridViewColumn) Removes the specified column from the collection.
Public method Remove(String) Removes the column with the specified name from the collection.
Public method RemoveAt Removes the column at the given index in the collection.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event CollectionChanged Occurs when the collection changes.
Top
  Name Description
Public Extension Method AsParallel Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension Method AsQueryable Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension Method Cast<TResult> Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension Method OfType<TResult> Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Infrastructure. Copies the entire contents of the collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Explicit interface implemetation Private property ICollection.Count Infrastructure. Gets the number of elements in the collection.
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether access to the collection is synchronized.
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the collection.
Explicit interface implemetation Private method IEnumerable.GetEnumerator Infrastructure. Returns an enumerator that iterates through the collection.
Explicit interface implemetation Private method IList.Add Infrastructure. Adds an object to the end of the collection.
Explicit interface implemetation Private method IList.Clear Infrastructure. Removes all elements from the collection.
Explicit interface implemetation Private method IList.Contains Infrastructure. Determines whether an object is in the collection.
Explicit interface implemetation Private method IList.IndexOf Infrastructure. Determines the index of a specific item in the collection.
Explicit interface implemetation Private method IList.Insert Infrastructure. Inserts an element into the collection at the specified index.
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the collection has a fixed size.
Explicit interface implemetation Private property IList.IsReadOnly Infrastructure. Gets a value indicating whether the collection is read-only.
Explicit interface implemetation Private property IList.Item Infrastructure. Gets or sets the element at the specified index.
Explicit interface implemetation Private method IList.Remove Infrastructure. Removes the first occurrence of the specified object from the collection.
Explicit interface implemetation Private method IList.RemoveAt Infrastructure. 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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ