TableColumnCollection Class

Namespace:
GemBox.Spreadsheet.Tables
Assembly:
GemBox.Spreadsheet.dll

A collection of TableColumn items. Supported in XLSX only.

public sealed class TableColumnCollection : IEnumerable<TableColumn>, IEnumerable
Public NotInheritable Class TableColumnCollection
    Implements IEnumerable(Of TableColumn), IEnumerable
Inheritance:
System.Object
TableColumnCollection
Implements
System.Collections.Generic.IEnumerable<TableColumn>
System.Collections.IEnumerable

Properties

Count

Gets the number of TableColumns contained in the collection.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

The number of TableColumns contained in the collection.

Item[Int32]

Gets the TableColumn at the specified index.

public TableColumn this[int index] { get; }
Public ReadOnly Property Item(index As Integer) As TableColumn
Parameters
index
System.Int32

The zero-based index of the TableColumn.

Property Value
TableColumn

Item[String]

Gets TableColumn described by name from the collection.

public TableColumn this[string name] { get; }
Public ReadOnly Property Item(name As String) As TableColumn
Parameters
name
System.String

Name of the table column.

Property Value
TableColumn

Methods

Add()

Adds a new TableColumn to the collection.

public TableColumn Add()
Public Function Add As TableColumn
Returns
TableColumn

Newly added TableColumn.

GetEnumerator()

Gets the collection enumerator.

public IEnumerator<TableColumn> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of TableColumn)
Returns
System.Collections.Generic.IEnumerator<TableColumn>

The collection enumerator.

Insert(Int32)

Inserts a new TableColumn at the specified index.

public TableColumn Insert(int index)
Public Function Insert(index As Integer) As TableColumn
Parameters
index
System.Int32

The column index.

Returns
TableColumn

Newly added TableColumn.

Exceptions
System.ArgumentOutOfRangeException

index is out of range.

Remove(TableColumn)

Removes the specified TableColumn.

public bool Remove(TableColumn column)
Public Function Remove(column As TableColumn) As Boolean
Parameters
column
TableColumn

The table column.

Returns
System.Boolean

true if TableColumn was removed from the collection; otherwise, false.

Exceptions
System.ArgumentNullException

column is null.

RemoveAt(Int32)

Removes the TableColumn at the specified index.

public void RemoveAt(int index)
Public Sub RemoveAt(index As Integer)
Parameters
index
System.Int32

The column index.

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable