IXlSheet.CreateColumn(Int32) Method

Creates a new column in the worksheet with the specified index.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

IXlColumn CreateColumn(
    int columnIndex
)

VB.NET

Function CreateColumn(
    columnIndex As Integer
) As IXlColumn

Parameters

Name	Type	Description
columnIndex	Int32	An integer specifying the zero-based index of the created column. If it is negative or exceeds the last available index, an exception is raised.

Returns

Type	Description
IXlColumn	An IXlColumn object that is the newly created column.

Remarks

Columns in a worksheet should be created prior to rows and cells. If you try to create a column after or during the row generation, an InvalidOperationException exception will be thrown.

Note

When you finish working with the IXlColumn object, call the Dispose method to release all the resources used by the object. Otherwise, generated content is not written to the output file. You can also modify the IXlColumn object within the using statement (Using block in Visual Basic).

Example

The example below demonstrates how to create and modify a column in a worksheet. To do this, use the IXlSheet.CreateColumn method. To specify where a created column should be located in a worksheet, pass a zero-based column index to the method as a parameter.

C#

// Create a new worksheet.
using (IXlSheet sheet = document.CreateSheet())
{
    // Create the column "A" and set its width to 100 pixels.
    using (IXlColumn column = sheet.CreateColumn())
    {
        column.WidthInPixels = 100;
    }

    // Create the column D and set its width to 24.5 characters.
    using (IXlColumn column = sheet.CreateColumn(3))
    {
        column.WidthInCharacters = 24.5f;
    }
}

VB.NET

' Create a new worksheet.
Using sheet As IXlSheet = document.CreateSheet()
    ' Create the column "A" and set its width to 100 pixels.
    Using column As IXlColumn = sheet.CreateColumn()
        column.WidthInPixels = 100
    End Using

    ' Create the column D and set its width to 24.5 characters.
    Using column As IXlColumn = sheet.CreateColumn(3)
        column.WidthInCharacters = 24.5F
    End Using
End Using

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateColumn(Int32) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

excel-export-api-examples/CS/XLExportExamples/SpreadsheetActions/GeneralActions.cs#L172

// Create the column D and set its width to 24.5 characters.
using (IXlColumn column = sheet.CreateColumn(3)) {
    column.WidthInCharacters = 24.5f;

VB.NET

excel-export-api-examples/VB/XLExportExamples/SpreadsheetActions/GeneralActions.vb#L167

' Create the column D and set its width to 24.5 characters.
Using column As IXlColumn = sheet.CreateColumn(3)
    column.WidthInCharacters = 24.5F