Show / Hide Table of Contents

Class ExcelTable

An Excel Table

Inheritance
System.Object
XmlHelper
ExcelTable
Implements
System.Collections.Generic.IEqualityComparer<ExcelTable>
Inherited Members
XmlHelper.AddSchemaNodeOrder(String[], String[])
XmlHelper.AddSchemaNodeOrder(String[], String[], Int32[])
XmlHelper.GetBoolFromString(String)
XmlHelper.CreatespPrNode(String, Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: OfficeOpenXml.Table
Assembly: EPPlus.dll
Syntax
public class ExcelTable : XmlHelper, IEqualityComparer<ExcelTable>

Properties

Address

The address of the table

Declaration
public ExcelAddressBase Address { get; }
Property Value
Type Description
ExcelAddressBase

AutoFilter

Autofilter settings for the table

Declaration
public ExcelAutoFilter AutoFilter { get; }
Property Value
Type Description
ExcelAutoFilter

Columns

Collection of the columns in the table

Declaration
public ExcelTableColumnCollection Columns { get; }
Property Value
Type Description
ExcelTableColumnCollection

DataCellStyleName

Named style used for the data cells

Declaration
public string DataCellStyleName { get; set; }
Property Value
Type Description
System.String

HeaderRowCellStyle

Named style used for the header row

Declaration
public string HeaderRowCellStyle { get; set; }
Property Value
Type Description
System.String

Name

The name of the table object in Excel

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Range

The table range

Declaration
public ExcelRangeBase Range { get; }
Property Value
Type Description
ExcelRangeBase

ShowColumnStripes

Display banded columns

Declaration
public bool ShowColumnStripes { get; set; }
Property Value
Type Description
System.Boolean

ShowFilter

If the header row has an autofilter

Declaration
public bool ShowFilter { get; set; }
Property Value
Type Description
System.Boolean

ShowFirstColumn

Display special formatting for the first row

Declaration
public bool ShowFirstColumn { get; set; }
Property Value
Type Description
System.Boolean

ShowHeader

If the header row is visible or not

Declaration
public bool ShowHeader { get; set; }
Property Value
Type Description
System.Boolean

ShowLastColumn

Display special formatting for the last row

Declaration
public bool ShowLastColumn { get; set; }
Property Value
Type Description
System.Boolean

ShowRowStripes

Display banded rows

Declaration
public bool ShowRowStripes { get; set; }
Property Value
Type Description
System.Boolean

ShowTotal

If the total row is visible or not

Declaration
public bool ShowTotal { get; set; }
Property Value
Type Description
System.Boolean

StyleName

The style name for custum styles

Declaration
public string StyleName { get; set; }
Property Value
Type Description
System.String

TableStyle

The table style. If this property is custom, the style from the StyleName propery is used.

Declaration
public TableStyles TableStyle { get; set; }
Property Value
Type Description
TableStyles

TableUri

The package internal URI to the Table Xml Document.

Declaration
public Uri TableUri { get; }
Property Value
Type Description
System.Uri

TableXml

Provides access to the XML data representing the table in the package.

Declaration
public XmlDocument TableXml { get; set; }
Property Value
Type Description
System.Xml.XmlDocument

TotalsRowCellStyle

Named style used for the total row

Declaration
public string TotalsRowCellStyle { get; set; }
Property Value
Type Description
System.String

WorkSheet

The worksheet of the table

Declaration
public ExcelWorksheet WorkSheet { get; set; }
Property Value
Type Description
ExcelWorksheet

Methods

AddRow(Int32)

Adds new rows to the table.

Declaration
public ExcelRangeBase AddRow(int rows = 1)
Parameters
Type Name Description
System.Int32 rows

Number of rows to add to the table. Default is 1

Returns
Type Description
ExcelRangeBase

DeleteRow(Int32, Int32)

Deletes one or more rows at the specified position in the table.

Declaration
public ExcelRangeBase DeleteRow(int position, int rows = 1)
Parameters
Type Name Description
System.Int32 position

The position in the table where the row will be deleted. 0 will delete the first row.

System.Int32 rows

Number of rows to delete.

Returns
Type Description
ExcelRangeBase

Equals(ExcelTable, ExcelTable)

Checkes if two tables are the same

Declaration
public bool Equals(ExcelTable x, ExcelTable y)
Parameters
Type Name Description
ExcelTable x

Table 1

ExcelTable y

Table 2

Returns
Type Description
System.Boolean

GetHashCode(ExcelTable)

Returns a hashcode generated from the TableXml

Declaration
public int GetHashCode(ExcelTable obj)
Parameters
Type Name Description
ExcelTable obj

The table

Returns
Type Description
System.Int32

The hashcode

InsertRow(Int32, Int32)

Inserts one or more rows before the specified position in the table.

Declaration
public ExcelRangeBase InsertRow(int position, int rows = 1)
Parameters
Type Name Description
System.Int32 position

The position in the table where the row will be inserted. Default is in the end of the table. 0 will insert the row at the top. Any value larger than the number of rows in the table will insert a row at the bottom of the table.

System.Int32 rows

Number of rows to insert.

Returns
Type Description
ExcelRangeBase

The inserted range

Implements

System.Collections.Generic.IEqualityComparer<T>
Back to top Generated by DocFX