Table of Contents

Interface IXLTable

Namespace
SlapKit.Excel.Excel
Assembly
SlapKit.Excel.dll
public interface IXLTable : IXLRange, IXLRangeBase, IXLAddressable
Inherited Members
Extension Methods

Properties

AutoFilter 

IXLAutoFilter AutoFilter { get; }

Property Value

IXLAutoFilter

DataRange 

IXLTableRange DataRange { get; }

Property Value

IXLTableRange

EmphasizeFirstColumn 

bool EmphasizeFirstColumn { get; set; }

Property Value

bool

EmphasizeLastColumn 

bool EmphasizeLastColumn { get; set; }

Property Value

bool

Fields 

IEnumerable<IXLTableField> Fields { get; }

Property Value

IEnumerable<IXLTableField>

Name

Change the name of a table. Structural references to the table are not updated.

string Name { get; set; }

Property Value

string

Exceptions

ArgumentException

If the new table name is already used by other table in the sheet.

ShowAutoFilter 

bool ShowAutoFilter { get; set; }

Property Value

bool

ShowColumnStripes 

bool ShowColumnStripes { get; set; }

Property Value

bool

ShowHeaderRow 

bool ShowHeaderRow { get; set; }

Property Value

bool

ShowRowStripes 

bool ShowRowStripes { get; set; }

Property Value

bool

ShowTotalsRow 

bool ShowTotalsRow { get; set; }

Property Value

bool

Theme 

XLTableTheme Theme { get; set; }

Property Value

XLTableTheme

Methods

AppendData(IEnumerable, bool)

Appends the IEnumerable data elements and returns the range of the new rows.

IXLRange AppendData(IEnumerable data, bool propagateExtraColumns = false)

Parameters

data IEnumerable

The IEnumerable data.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The range of the new rows.

AppendData(IEnumerable, bool, bool)

Appends the IEnumerable data elements and returns the range of the new rows.

IXLRange AppendData(IEnumerable data, bool transpose, bool propagateExtraColumns = false)

Parameters

data IEnumerable

The IEnumerable data.

transpose bool

if set to true the data will be transposed before inserting.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The range of the new rows.

AppendData(DataTable, bool)

Appends the data of a data table and returns the range of the new rows.

IXLRange AppendData(DataTable dataTable, bool propagateExtraColumns = false)

Parameters

dataTable DataTable

The data table.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The range of the new rows.

AppendData<T>(IEnumerable<T>, bool)

Appends the IEnumerable data elements and returns the range of the new rows.

IXLRange AppendData<T>(IEnumerable<T> data, bool propagateExtraColumns = false)

Parameters

data IEnumerable<T>

The table data.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The range of the new rows.

Type Parameters

T

AsDynamicEnumerable()

Converts the table to an enumerable of dynamic objects

IEnumerable<dynamic> AsDynamicEnumerable()

Returns

IEnumerable<object>

AsNativeDataTable()

Converts the table to a standard .NET System.Data.DataTable

DataTable AsNativeDataTable()

Returns

DataTable

Clear(XLClearOptions)

Clears the contents of this table.

IXLTable Clear(XLClearOptions clearOptions = XLClearOptions.All)

Parameters

clearOptions XLClearOptions

Specify what you want to clear.

Returns

IXLTable

CopyTo(IXLWorksheet) 

IXLTable CopyTo(IXLWorksheet targetSheet)

Parameters

targetSheet IXLWorksheet

Returns

IXLTable

Field(int) 

IXLTableField Field(int fieldIndex)

Parameters

fieldIndex int

Returns

IXLTableField

Field(string) 

IXLTableField Field(string fieldName)

Parameters

fieldName string

Returns

IXLTableField

HeadersRow() 

IXLRangeRow HeadersRow()

Returns

IXLRangeRow

ReplaceData(IEnumerable, bool)

Replaces the IEnumerable data elements and returns the table's data range.

IXLRange ReplaceData(IEnumerable data, bool propagateExtraColumns = false)

Parameters

data IEnumerable

The IEnumerable data.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The table's data range.

ReplaceData(IEnumerable, bool, bool)

Replaces the IEnumerable data elements and returns the table's data range.

IXLRange ReplaceData(IEnumerable data, bool transpose, bool propagateExtraColumns = false)

Parameters

data IEnumerable

The IEnumerable data.

transpose bool

if set to true the data will be transposed before inserting.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The table's data range.

ReplaceData(DataTable, bool)

Replaces the data from the records of a data table and returns the table's data range.

IXLRange ReplaceData(DataTable dataTable, bool propagateExtraColumns = false)

Parameters

dataTable DataTable

The data table.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The table's data range.

ReplaceData<T>(IEnumerable<T>, bool)

Replaces the IEnumerable data elements as a table and the table's data range.

IXLRange ReplaceData<T>(IEnumerable<T> data, bool propagateExtraColumns = false)

Parameters

data IEnumerable<T>

The table data.

propagateExtraColumns bool

if set to true propagate extra columns' values and formulas.

Returns

IXLRange

The table's data range.

Type Parameters

T

Resize(IXLAddress, IXLAddress)

Resizes the table to the specified range.

IXLTable Resize(IXLAddress firstCellAddress, IXLAddress lastCellAddress)

Parameters

firstCellAddress IXLAddress

The first cell address in the worksheet.

lastCellAddress IXLAddress

The last cell address in the worksheet.

Returns

IXLTable

Resize(IXLCell, IXLCell)

Resizes the table to the specified range.

IXLTable Resize(IXLCell firstCell, IXLCell lastCell)

Parameters

firstCell IXLCell

The first cell in the range.

lastCell IXLCell

The last cell in the range.

Returns

IXLTable

Resize(IXLRange)

Resizes the table to the specified range address.

IXLTable Resize(IXLRange range)

Parameters

range IXLRange

The new table range.

Returns

IXLTable

Resize(IXLRangeAddress)

Resizes the table to the specified range address.

IXLTable Resize(IXLRangeAddress rangeAddress)

Parameters

rangeAddress IXLRangeAddress

The range boundaries.

Returns

IXLTable

Resize(int, int, int, int)

Resizes the table to the specified range.

IXLTable Resize(int firstCellRow, int firstCellColumn, int lastCellRow, int lastCellColumn)

Parameters

firstCellRow int

The first cell's row of the range to return.

firstCellColumn int

The first cell's column of the range to return.

lastCellRow int

The last cell's row of the range to return.

lastCellColumn int

The last cell's column of the range to return.

Returns

IXLTable

Resize(string)

Resizes the table to the specified range address.

IXLTable Resize(string rangeAddress)

Parameters

rangeAddress string

The range boundaries.

Returns

IXLTable

Resize(string, string)

Resizes the table to the specified range.

IXLTable Resize(string firstCellAddress, string lastCellAddress)

Parameters

firstCellAddress string

The first cell address in the worksheet.

lastCellAddress string

The last cell address in the worksheet.

Returns

IXLTable

SetAutoFilter() 

IXLAutoFilter SetAutoFilter()

Returns

IXLAutoFilter

SetEmphasizeFirstColumn() 

IXLTable SetEmphasizeFirstColumn()

Returns

IXLTable

SetEmphasizeFirstColumn(bool) 

IXLTable SetEmphasizeFirstColumn(bool value)

Parameters

value bool

Returns

IXLTable

SetEmphasizeLastColumn() 

IXLTable SetEmphasizeLastColumn()

Returns

IXLTable

SetEmphasizeLastColumn(bool) 

IXLTable SetEmphasizeLastColumn(bool value)

Parameters

value bool

Returns

IXLTable

SetShowAutoFilter() 

IXLTable SetShowAutoFilter()

Returns

IXLTable

SetShowAutoFilter(bool) 

IXLTable SetShowAutoFilter(bool value)

Parameters

value bool

Returns

IXLTable

SetShowColumnStripes() 

IXLTable SetShowColumnStripes()

Returns

IXLTable

SetShowColumnStripes(bool) 

IXLTable SetShowColumnStripes(bool value)

Parameters

value bool

Returns

IXLTable

SetShowHeaderRow() 

IXLTable SetShowHeaderRow()

Returns

IXLTable

SetShowHeaderRow(bool) 

IXLTable SetShowHeaderRow(bool value)

Parameters

value bool

Returns

IXLTable

SetShowRowStripes() 

IXLTable SetShowRowStripes()

Returns

IXLTable

SetShowRowStripes(bool) 

IXLTable SetShowRowStripes(bool value)

Parameters

value bool

Returns

IXLTable

SetShowTotalsRow() 

IXLTable SetShowTotalsRow()

Returns

IXLTable

SetShowTotalsRow(bool) 

IXLTable SetShowTotalsRow(bool value)

Parameters

value bool

Returns

IXLTable

TotalsRow() 

IXLRangeRow TotalsRow()

Returns

IXLRangeRow