ColumnCollection.Insert(Int32) Method
Inserts a new column into the worksheet at the specified position.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v19.1.Core.dll
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| index | Int32 | A zero-based index of the position where to insert a new column. If it is negative or exceeds the last available index (16383), an exception occurs. |
Remarks
The number of columns in a worksheet is unchanged - 16,384. When you add new columns, other columns in the worksheet are shifted to the right, and the equivalent number of columns at the end are automatically removed from the worksheet.
To copy data (for example, values, formulas, formatting, etc.) from one column to another one, use the Range.CopyFrom method. For details, see the How to: Copy a Row or Column example.
Example
This example demonstrates how to insert new columns into a worksheet.
- Use the Column.Insert method to add a new column to the left of the current column.
- Call the ColumnCollection.Insert method of the Worksheet.Columns collection to insert a column at the specified position or add multiple columns at once.
- To insert empty columns to the left of the specified cell range, use the Worksheet.InsertCells method with the InsertCellsMode.EntireColumn enumeration member passed as a parameter. This method inserts the same number of columns as the specified cell range contains.
Enclose your code in the Workbook.BeginUpdate - Workbook.EndUpdate method calls to improve performance when you add multiple columns to a document.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339
// Insert a new column C.
worksheet.Columns["C"].Insert();
// Insert a new column into the worksheet at the 5th position.
worksheet.Columns.Insert(4);
// Insert three columns into the worksheet at the 7th position.
worksheet.Columns.Insert(6, 3);
// Insert two columns to the left of the "L15:M16" cell range.
worksheet.InsertCells(worksheet.Range["L15:M16"], InsertCellsMode.EntireColumn);