Class ExcelTableCollection¶

Namespace: OfficeOpenXml.Table
Assembly: EPPlus.dll

A collection of table objects

public class ExcelTableCollection : IEnumerable<ExcelTable>, IEnumerable

Inheritance¶

object ← ExcelTableCollection

Implements¶

IEnumerable
IEnumerable<ExcelTable>

Inherited Members¶

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties¶

Count¶

Number of items in the collection

public int Count { get; }

Property Value¶

int

this[int]¶

The table Index. Base 0.

public ExcelTable this[int Index] { get; }

Property Value¶

ExcelTable

this[string]¶

Indexer

public ExcelTable this[string Name] { get; }

Property Value¶

ExcelTable

Methods¶

Add(ExcelAddressBase, string)¶

Create a table on the supplied range

public ExcelTable Add(ExcelAddressBase Range, string Name)

Parameters¶

Range ExcelAddressBase

The range address including header and total row

Name string

The name of the table. Must be unique

Returns¶

ExcelTable

The table object

AddQueryTable(ExcelAddressBase, string, ExcelConnection, params string[])¶

Adds a new query table to the collection. To add a new query table you need to specify the queries field names.

public ExcelTable AddQueryTable(ExcelAddressBase Range, string Name, ExcelConnection connection, params string[] fields)

Parameters¶

Range ExcelAddressBase

The range to the table.

Name string

The name of the table

connection ExcelConnection

The connection in the Connections collection.

fields string[]

The names of the fields. EPPlus does not execute the query, so you must set the field names and update the field properties in the Fields collection.

Returns¶

ExcelTable

Exceptions¶

ArgumentException

If no fields are supplied

InvalidOperationException

If the connection is null or not in the package.

Delete(int, bool)¶

Delete the table at the specified index

public void Delete(int Index, bool ClearRange = false)

Parameters¶

Index int

The index

ClearRange bool

Clear the rage if set to true

Delete(string, bool)¶

Delete the table with the specified name

public void Delete(string Name, bool ClearRange = false)

Parameters¶

Name string

The name of the table to be deleted

ClearRange bool

Clear the rage if set to true

Delete(ExcelTable, bool)¶

Delete the table and removes it from the collection

public void Delete(ExcelTable Table, bool ClearRange = false)

Parameters¶

Table ExcelTable

The table object

ClearRange bool

Clear the table range

GetEnumerator()¶

Gets the enumerator for the collection

public IEnumerator<ExcelTable> GetEnumerator()

Returns¶

IEnumerator<ExcelTable>

The enumerator

GetFromRange(ExcelRangeBase)¶

Get the table object from a range.

public ExcelTable GetFromRange(ExcelRangeBase Range)

Parameters¶

Range ExcelRangeBase

The range

Returns¶

ExcelTable

The table. Null if no range matches