Table Class

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

Represents a worksheet table. Supported in XLSX only.

public sealed class Table
Public NotInheritable Class Table
Inheritance:
System.Object
Table

Properties

AlternativeText

Gets the table alternative text.

public TableAlternativeText AlternativeText { get; }
Public ReadOnly Property AlternativeText As TableAlternativeText
Property Value
TableAlternativeText

The alternative text.

BuiltInStyle

Gets or sets the built-in style used in the body of the Table.

public BuiltInTableStyleName BuiltInStyle { get; set; }
Public Property BuiltInStyle As BuiltInTableStyleName
Property Value
BuiltInTableStyleName

The built-in style used in the body of the Table.

Columns

Gets the collection of table columns.

public TableColumnCollection Columns { get; }
Public ReadOnly Property Columns As TableColumnCollection
Property Value
TableColumnCollection

The collection of table columns.

DataRange

Gets the table data range.

public CellRange DataRange { get; }
Public ReadOnly Property DataRange As CellRange
Property Value
CellRange
Remarks

Property returns table range without header row and, if enabled, totals row.

Filter

Gets or sets the table filter. Returns null if no AutoFilter is active.

public AutoFilter Filter { get; set; }
Public Property Filter As AutoFilter
Property Value
AutoFilter

The table filter.

HasHeaderRow

Gets if table has header row or not

public bool HasHeaderRow { get; set; }
Public Property HasHeaderRow As Boolean
Property Value
System.Boolean

True if this table has header row; otherwise, false

HasTotalsRow

Gets or sets a value indicating whether this table has a totals row.

public bool HasTotalsRow { get; set; }
Public Property HasTotalsRow As Boolean
Property Value
System.Boolean

True if this table has totals row; otherwise, false.

Name

Gets the table name.

public string Name { get; }
Public ReadOnly Property Name As String
Property Value
System.String

The table name.

Range

Gets the table range.

public CellRange Range { get; }
Public ReadOnly Property Range As CellRange
Property Value
CellRange
Remarks

Property returns complete table range which includes header row and, if enabled, totals row.

Rows

Gets the collection of table rows.

public TableRowCollection Rows { get; }
Public ReadOnly Property Rows As TableRowCollection
Property Value
TableRowCollection

The collection of table rows.

Sort

Gets the table sort.

public SortState Sort { get; }
Public ReadOnly Property Sort As SortState
Property Value
SortState

The table sort.

StyleOptions

Gets or sets the options to be applied to the Table style.

public TableStyleOptions StyleOptions { get; set; }
Public Property StyleOptions As TableStyleOptions
Property Value
TableStyleOptions

The options to be applied to the Table style.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to this Table instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this Table instance.

Returns
System.Boolean

true if the specified System.Object is a Table and is equal to this Table instance; otherwise, false.

Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for this Table instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this Table instance.

Overrides
System.Object.GetHashCode()

ToString()

Returns a System.String that represents this Table instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this Table instance.

Overrides
System.Object.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).