ExcelColumnCollection Class

GemBox.Spreadsheet Help

Collection of excel columns (ExcelColumn).

Inheritance Hierarchy

System Object
  GemBox.Spreadsheet ExcelRowColumnCellCollectionBase
    GemBox.Spreadsheet ExcelRowColumnCollectionBase
      GemBox.Spreadsheet ExcelRowColumnCollectionBase ExcelColumn
        GemBox.Spreadsheet ExcelColumnCollection

Namespace: GemBox.Spreadsheet
Assembly: GemBox.Spreadsheet (in GemBox.Spreadsheet.dll) Version: 37.3.30.1035

Syntax

Copy to Clipboard Print

public sealed class ExcelColumnCollection : ExcelRowColumnCollectionBase<ExcelColumn>

public sealed class ExcelColumnCollection : ExcelRowColumnCollectionBase<ExcelColumn>

Public NotInheritable Class ExcelColumnCollection _
	Inherits ExcelRowColumnCollectionBase(Of ExcelColumn)

Public NotInheritable Class ExcelColumnCollection _
	Inherits ExcelRowColumnCollectionBase(Of ExcelColumn)

Remarks

Note that the cells are internally allocated in rows and not in columns. ExcelColumn objects are created only if they have non-standard width or style, or they are accessed directly. So, while ExcelRowCollection.Count shows number of rows occupied with data, ExcelColumnCollection.Count does not say which Column is the last one occupied with data!

If you want to read all data in a sheet, use ExcelRow.AllocatedCells property.

If you want to find last column occupied with data, use CalculateMaxUsedColumns method.

Examples

Following code shows how to get hidden columns and shows how to get number of columns occupied with data.

Copy to Clipboard Print

foreach (ExcelColumn column in ws.Columns)
{
    // Writes hidden columns 
    if(column.Hidden)
        Console.WriteLine("Column '{0}' is hidden", ExcelColumnCollection.ColumnIndexToName(column.Index));
}

// Counts used columns (columns that contain some data)
Console.WriteLine("Number of used columns is: {0}", ws.CalculateMaxUsedColumns());

foreach (ExcelColumn column in ws.Columns)
{
    // Writes hidden columns 
    if(column.Hidden)
        Console.WriteLine("Column '{0}' is hidden", ExcelColumnCollection.ColumnIndexToName(column.Index));
}

// Counts used columns (columns that contain some data)
Console.WriteLine("Number of used columns is: {0}", ws.CalculateMaxUsedColumns());

For Each column In ws.Columns
    ' Writes hidden columns 
    If column.Hidden Then
        Console.WriteLine("Column '{0}' is hidden", ExcelColumnCollection.ColumnIndexToName(column.Index))
    End If 
Next 

' Counts used columns (columns that contain some data)
Console.WriteLine("Number of used columns is: {0}", ws.CalculateMaxUsedColumns())

For Each column In ws.Columns
    ' Writes hidden columns 
    If column.Hidden Then
        Console.WriteLine("Column '{0}' is hidden", ExcelColumnCollection.ColumnIndexToName(column.Index))
    End If 
Next 

' Counts used columns (columns that contain some data)
Console.WriteLine("Number of used columns is: {0}", ws.CalculateMaxUsedColumns())