System.Web.UI.WebControls Namespace   DataGridColumnCollection Class

Inserts a DataGridColumn to the collection at the specified index.

[ VB ]
Public Sub AddAt ( _
   ByVal index As Integer, _
   ByVal column As DataGridColumn _
)

[ C# ]
public void AddAt (
   int index,
   DataGridColumn column
);

[ C++ ]
public: void AddAt (
   int index,
   DataGridColumn* column
);

[ JScript ]
public function AddAt (
   index : int,
   column : DataGridColumn
);

index

The zero-based index location in the collection to insert the DataGridColumn object.

index

The DataGridColumn object to insert into the collection.

Use this method to insert a DataGridColumn derived object at the specified index location in the DataGridColumnCollection.

The DataGrid control does not store the contents of its Columns collection into the view state. To add or remove a column dynamically, you must programmaticallt add or remove the column each time the page is refreshed. Provide a Page_Init function that adds or removes the column before the DataGrid control can reload its state and rebuild itself. Otherwise, the changes to the Columns collection are not reflected in the DataGrid control when it is displayed.

NOTE: While you can programmatically add columns to or remove columns from the Columns collection of the DataGrid control, it is easier to list the columns statically and then use the Visible property to display or hide each column.

The following example demonstrates how use the AddAt method to dynamically add a column to a DataGrid control.

void Page_Init ( Object src, EventArgs e ) {
   // create a dynamic column to add to Columns collection.
   BoundColumn newColumn = new BoundColumn ( );
   newColumn.HeaderText = "Item Number"; 
   newColumn.DataField = "ProductID";

   // add column to Columns collection.
   myGrid.Columns.AddAt ( 0, newColumn );
}

Sub Page_Init ( src As Object, e As EventArgs )
   ' create a dynamic column to add to Columns collection.
   Dim newColumn As New BoundColumn ( )
   newColumn.HeaderText = "Item Number"
   newColumn.DataField = "ProductID"

   ' add column to Columns collection.
   myGrid.Columns.AddAt ( 0, newColumn )
End Sub

DataGridColumnCollection Members   Add   Remove   RemoveAt

Books and more ...

Custom Search