This topic has not yet been rated - Rate this topic

DataGridViewColumnCollection.Remove Method (String)

.NET Framework 3.5

Other Versions

Removes the column with the specified name from the collection.

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

Syntax

C++

JScript

public virtual void Remove(
	string columnName
)

Parameters

columnName: Type: System.String
The name of the column to delete.

Exceptions

Exception	Condition
ArgumentException	columnName does not match the name of any column in the collection.
ArgumentNullException	columnName is null.
InvalidOperationException	The associated DataGridView control is performing one of the following actions that temporarily prevents new columns from being added: Selecting all cells in the control. Clearing the selection. Updating column DisplayIndex property values. -or- This method is being called from a handler for one of the following DataGridView events: CellEnter CellLeave CellValidating CellValidated RowEnter RowLeave RowValidated RowValidating

Exception

Condition

ArgumentException

columnName does not match the name of any column in the collection.

ArgumentNullException

columnName is null.

InvalidOperationException

The associated DataGridView control is performing one of the following actions that temporarily prevents new columns from being added:

Selecting all cells in the control.
Clearing the selection.
Updating column DisplayIndex property values.

-or-

This method is being called from a handler for one of the following DataGridView events:

Remarks

The name of a column is indicated by the DataGridViewColumn.Name property.

To remove a column that is automatically generated when binding to a data source, call this method in a DataGridView.DataBindingComplete event handler.

Examples

The following code example illustrates the use of this method. For more information, see How to: Remove Autogenerated Columns from a Windows Forms DataGridView Control.

private void BindDataAndInitializeColumns()
{
    dataGridView1.AutoGenerateColumns = true;
    dataGridView1.DataSource = customersDataSet;
    dataGridView1.Columns.Remove("Fax");
    dataGridView1.Columns["CustomerID"].Visible = false;
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

DataGridViewColumnCollection Class

DataGridViewColumnCollection Members

Remove Overload

System.Windows.Forms Namespace

DataGridView

DataGridView.DataBindingComplete

DataGridViewColumn

DataGridViewColumn.Name

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD