ColumnCollection.Remove(Int32, Int32) Method

Removes multiple columns from a worksheet.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

void Remove(
    int index,
    int count
)

VB.NET

Sub Remove(
    index As Integer,
    count As Integer
)

Parameters

Name	Type	Description
index	Int32	A zero-based index of the first column to remove. If it is negative or exceeds the last available index (16383), an exception occurs.
count	Int32	Specifies the number of columns to remove.

Remarks

The number of columns in a worksheet is unchanged - 16,384. When you delete columns, other columns in the worksheet are shifted to the left and the equivalent number of new columns is automatically added to the end of the worksheet’s column collection.

If you need to delete only the cell content or formatting from columns without removing entire columns from the worksheet, use the Clear* methods of the Worksheet object (see the How to: Clear Cells of Content, Formatting, Hyperlinks and Comments example).

You can also hide unnecessary columns without deleting them from the worksheet. To do this, use the Column.Visible property (see the How to: Hide a Row or a Column example).

Example

This example demonstrates how to remove columns from a worksheet.

• Call the Column.Delete method to delete the current column.
• Call the ColumnCollection.Remove method of the Worksheet.Columns collection to remove a column at the specified position or delete multiple columns at once.
• To delete a column containing the specified cell or multiple columns containing the specified cell range, use the Worksheet.DeleteCells method with the DeleteMode.EntireColumn enumeration member passed as a parameter.

When you delete columns from a worksheet, other columns are automatically shifted to the left.

Enclose your code in the Workbook.BeginUpdate - Workbook.EndUpdate method calls to improve performance when you remove multiple columns from a document.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339

RowAndColumnActions.cs

// Delete the 2nd column from the worksheet.
worksheet.Columns[1].Delete();

// Delete the 3rd column from the worksheet.
worksheet.Columns.Remove(2);

// Delete three columns from the worksheet starting from the 10th column.
worksheet.Columns.Remove(9, 3);

// Delete a column that contains the "B2"cell.
worksheet.DeleteCells(worksheet.Cells["B2"], DeleteMode.EntireColumn);

RowAndColumnActions.vb

' Delete the 2nd column from the worksheet.
worksheet.Columns(1).Delete()

' Delete the 3rd column from the worksheet.
worksheet.Columns.Remove(2)

' Delete three columns from the worksheet starting from the 10th column.
worksheet.Columns.Remove(9, 3)

' Delete a column that contains the "B2"cell.
worksheet.DeleteCells(worksheet.Cells("B2"), DeleteMode.EntireColumn)