DataGridViewColumnCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• BaseCollection

  • DataGridViewColumnCollection

Represents a collection of DataGridViewColumn objects in a DataGridView control.

public class DataGridViewColumnCollection : BaseCollection, IList, IList<DataGridViewColumn>, ICollection<DataGridViewColumn>, IEnumerable<DataGridViewColumn>

Public Class DataGridViewColumnCollection
    Inherits BaseCollection
    Implements IList, IList(Of DataGridViewColumn), ICollection(Of DataGridViewColumn), IEnumerable(Of DataGridViewColumn)

Constructors

DataGridViewColumnCollection(dataGrid)

Initializes a new instance of the DataGridViewColumnCollection class for the given DataGridView.

Properties

Item(index)

DataGridViewColumn: Returns the column at the given index in the collection.

Throws:

• ArgumentOutOfRangeException index is less than zero or greater than the number of columns in the collection minus one.

DataGridViewColumn: Returns the column of the given name in the collection.

Throws:

• ArgumentNullException name is null.

Methods

Adds the given DataGridViewColumn to the collection.

Returns: Int32. The index of the column.

Throws:

• ArgumentNullException column 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

Adds a DataGridViewTextBoxColumn with the given column name to the collection.

Returns: Int32. The index of the column.

Throws:

• 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

Adds a DataGridViewTextBoxColumn with the given column name and call value type to the collection.

Returns: Int32. The index of the column.

Throws:

• 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

Adds a DataGridViewTextBoxColumn with the given column name and column header text to the collection.

Returns: Int32. The index of the column.

Throws:

• 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

Adds a DataGridViewTextBoxColumn with the given column name, column header text, and cell value type to the collection.

Returns: Int32. The index of the column.

Throws:

• 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

Adds a range of columns to the collection.

Throws:

• ArgumentNullException newColumns 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

Clears the collection.

Throws:

• 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

Clears the collection and disposes the columns.

Determines whether the collection contains the given DataGridViewColumn.

Returns: Boolean. true if the given column is in the collection; otherwise, false.

Determines whether the collection contains the given DataGridViewColumn.

Returns: Boolean. true if the given column is in the collection; otherwise, false.

Copies the items from the collection to the given array.

Returns the number of columns that match the includeFilter .

Returns: Int32. The number of columns that match the filter.

Throws:

• ArgumentException includeFilter is not a valid combination of DataGridViewElementStates values.

Returns the width, in pixels, required to display all of the columns that meet the includeFilter .

Returns: Int32. The width, in pixels, that is necessary to display all of the columns that match the filter.

Throws:

• ArgumentException includeFilter is not a valid combination of DataGridViewElementStates values.

Returns the first DataGridViewColumn in display order that matches the includeFilter and excludeFilter .

Returns: DataGridViewColumn. The first DataGridViewColumn in display order that matches the given filters, or null if no column is found.

Throws:

• ArgumentException At least one of the filter values is not a valid combination of DataGridViewElementStates values.

Returns the last DataGridViewColumn in display order that matches the includeFilter and excludeFilter .

Returns: DataGridViewColumn. The last displayed DataGridViewColumn in display order that matches the specified filters, or null if no column is found.

Throws:

• ArgumentException At least one of the filter values is not a valid combination of DataGridViewElementStates values.

Returns the first DataGridViewColumn after the given column in display order that matches the includeFilter and excludeFilter .

Returns: DataGridViewColumn. The next DataGridViewColumn that matches the filters, or null if no column is found.

Throws:

• ArgumentNullException startColumn is null.

• ArgumentException At least one of the filter values is not a valid combination of DataGridViewElementStates values.

Returns the last DataGridViewColumn prior to the given column in display order that matches the includeFilter and excludeFilter .

Returns: DataGridViewColumn. The previous column that matches the given filters, or null if no column is found.

Throws:

• ArgumentNullException startColumn is null.

• ArgumentException At least one of the filter values is not a valid combination of DataGridViewElementStates values.

Returns the index of the given DataGridViewColumn in the collection.

Returns: Int32. The index of the given DataGridViewColumn.

Returns the index of the DataGridViewColumn with the specified name from the collection.

Returns: Int32. The index of the given DataGridViewColumn.

Throws:

• ArgumentNullException name is null.

Inserts a DataGridViewColumn at the given index in the collection.

Throws:

• ArgumentNullException column 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 a column's DisplayIndex property value or this method is being called from a handler for one of the following DataGridView events:

• CellEnter

• CellLeave

• CellValidating

• CellValidated

• RowEnter

• RowLeave

• RowValidated

• RowValidating or column already belongs to a DataGridView control; or the column 's SortMode property value is Automatic and the SelectionMode property value is FullColumnSelect or ColumnHeaderSelect. Use the control's BeginInit and EndInit methods to temporarily set conflicting property values; or the column 's InheritedAutoSizeMode property value is ColumnHeader and the ColumnHeadersVisible property value is false; or column has an InheritedAutoSizeMode property value of Fill and a Frozen property value of true; or column has DisplayIndex and Frozen property values that would display it among a set of adjacent columns with the opposite Frozen property value; or the DataGridView control contains at least one row and column has a CellType property value of null.

Removes the specified DataGridViewColumn from the collection.

Throws:

• ArgumentException column is not in the collection.

• ArgumentNullException column 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 a column's DisplayIndex property value or this method is being called from a handler for one of the following DataGridView events:

• CellEnter

• CellLeave

• CellValidating

• CellValidated

• RowEnter

• RowLeave

• RowValidated

• RowValidating

Removes the DataGridViewColumn with the specified name from the collection.

Throws:

• ArgumentException name does not match the name of any column in the collection.

• ArgumentNullException name 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 a column's DisplayIndex property value or this method is being called from a handler for one of the following DataGridView events:

• CellEnter

• CellLeave

• CellValidating

• CellValidated

• RowEnter

• RowLeave

• RowValidated

• RowValidating

Removes the DataGridViewColumn at the given index in the collection.

Throws:

• ArgumentOutOfRangeException index is less than zero or greater than the number of columns in the control minus one.

• 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 a column's DisplayIndex property value or this method is being called from a handler for one of the following DataGridView events:

• CellEnter

• CellLeave

• CellValidating

• CellValidated

• RowEnter

• RowLeave

• RowValidated

• RowValidating

Moves the specified column to the new newIndex .

This method updates both the column's index in the column collection and the display index without firing the ColumnDisplayIndexChanged event.

Events

CollectionChangeEventHandler Fired when the collection changes.