GrapeCity.Documents.Excel.ITable

Interface ITable

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents a table object on a worksheet.

public interface ITable

Properties

AutoFilter

Filters a list using the IAutoFilter (read-only).

IAutoFilter AutoFilter { get; }

Property Value

IAutoFilter

AutoGenerateColumns

Gets or sets whether to generate columns automatically while binding data.

bool AutoGenerateColumns { get; set; }

Property Value

bool

BindingPath

Gets or sets binding path of current table.

string BindingPath { get; set; }

Property Value

string

Columns

Returns an ITableColumns collection that represents all the columns in the ITable object.

ITableColumns Columns { get; }

Property Value

ITableColumns

Comment

Gets or sets the comment associated with the table object.

string Comment { get; set; }

Property Value

string

DataRange

Returns the IRange object that represents the range that contains the data area in the table between the header row and the insert row.

IRange DataRange { get; }

Property Value

IRange

DisplayName

Gets or sets the display name for the specified ITable.

string DisplayName { get; set; }

Property Value

string

ExpandBoundRows

Gets or sets whether to add/delete entire rows on data binding.

bool ExpandBoundRows { get; set; }

Property Value

bool

HeaderRange

Returns the IRange object that represents the range of the header row for a table.

IRange HeaderRange { get; }

Property Value

IRange

Name

Gets or sets the name of the ITable object.

string Name { get; set; }

Property Value

string

Range

Returns the IRange object that represents the range to which the specified table object applies.

IRange Range { get; }

Property Value

IRange

Rows

Returns the ITableRows that represents all the rows of data in the ITable object.

ITableRows Rows { get; }

Property Value

ITableRows

ShowAutoFilter

Gets or sets whether the AutoFilter is displayed.

bool ShowAutoFilter { get; set; }

Property Value

bool

ShowAutoFilterDropDown

Gets or sets whether the table filter button is visible.

bool ShowAutoFilterDropDown { get; set; }

Property Value

bool

ShowHeaders

Gets or sets whether the header information should be displayed for the specified ITable object (read or write).

bool ShowHeaders { get; set; }

Property Value

bool

ShowTableStyleColumnStripes

Gets or sets if the column stripes table style is used for the specified ITable object (read or write).

bool ShowTableStyleColumnStripes { get; set; }

Property Value

bool

ShowTableStyleFirstColumn

Gets or sets if the first column is formatted for the specified ITable object (read or write).

bool ShowTableStyleFirstColumn { get; set; }

Property Value

bool

ShowTableStyleLastColumn

Gets or sets if the last column is displayed for the specified ITable object (read or write).

bool ShowTableStyleLastColumn { get; set; }

Property Value

bool

ShowTableStyleRowStripes

Gets or sets if the row stripes table style is used for the specified ITable object (read or write).

bool ShowTableStyleRowStripes { get; set; }

Property Value

bool

ShowTotals

Gets or sets whether the total row is visible.

bool ShowTotals { get; set; }

Property Value

bool

Sort

Gets the sort column or columns, and sort order for the ITable collection.

ISort Sort { get; }

Property Value

ISort

TableStyle

Gets or sets the table style for the specified ITable object (read or write).

ITableStyle TableStyle { get; set; }

Property Value

ITableStyle

TotalsRange

Returns the IRange object that represents the Total row, if any, from a specified ITable object.

IRange TotalsRange { get; }

Property Value

IRange

Methods

ConvertToRange()

Convert the range of cells that made up the table to a regular range of data.

void ConvertToRange()

Delete()

Deletes the ITable object and clears the cell data from the worksheet.

void Delete()

FromJson(string)

Generate table from Json string.

void FromJson(string json)

Parameters

json string

The JSON string representing the table.

Resize(IRange)

The Resize method allows the ITable object to be resized over a new range. No cells are inserted or moved.

NOTE: The headers must remain in the same row, and the resulting table range must overlap the original table range.

void Resize(IRange range)

Parameters

range IRange

Required IRange.

ToJson()

Generate json string from table.

string ToJson()

Returns

string

The JSON string representing the table.