Interface ITable
public interface ITable
Represents a table object on a worksheet.
-
Method Summary
void
Convert the range of cells that made up the table to a regular range of data.
void
Deletes the
ITable
object and clears the cell data from theworksheet.
void
Generate the table from json string.
boolean
Gets whether to generate columns automatically while binding data.
Gets the binding path of current table.
Gets the comment associated with the table object.
Returns the
IRange
object that represents the range that contains thedata area in the table between the header row and the insert row.
Gets the display name for the specified
ITable
.
boolean
Gets whether to add/delete entire rows on data binding.
Returns the
IRange
object that represents the range of the header rowfor a table.
Gets the name of the
ITable
object.
Returns the
IRange
object that represents the range to which thespecified table object applies.
Returns the
ITableRows
that represents all the rows of data in the
ITable
object.
boolean
Gets whether the AutoFilter is displayed.
boolean
Gets whether the table filter button is visible.
boolean
Gets whether the header information should be displayed for the specified
ITable
object.
boolean
Gets if the column stripes table style is used for the specified
ITable
object .
boolean
Gets if the first column is formatted for the specified
ITable
object.
boolean
Gets if the last column is displayed for the specified
ITable
object.
boolean
Gets if the row stripes table style is used for the specified
ITable
object.
boolean
Gets whether the total row is visible.
Gets the sort column or columns, and sort order for the
ITable
collection.
Gets the table style for the specified
ITable
object.
Returns the
IRange
object that represents the Total row, if any, froma specified
ITable
object.
void
The Resize method allows the
ITable
object to be resized over a newrange.
void
Sets whether to generate columns automatically while binding data.
void
Sets the binding path of current table.
void
Sets the comment associated with the table object.
void
Sets the display name for the specified
ITable
.
void
Sets whether to add/delete entire rows on data binding.
void
Sets the name of the
ITable
object.
void
Sets whether the AutoFilter is displayed.
void
Sets whether the table filter button is visible.
void
Sets whether the header information should be displayed for the specified
ITable
object.
void
Sets if the column stripes table style is used for the specified
ITable
object .
void
Sets if the first column is formatted for the specified
ITable
object.
void
Sets if the last column is displayed for the specified
ITable
object.
void
Sets if the row stripes table style is used for the specified
ITable
object.
void
Sets whether the total row is visible.
void
Sets the table style for the specified
ITable
object.
Generate the string from table.
-
Method Details
-
getName
Gets the name of the
ITable
object.
-
setName
Sets the name of the
ITable
object.
-
getDisplayName
Gets the display name for the specified
ITable
.
-
setDisplayName
void setDisplayName(String value)
Sets the display name for the specified
ITable
.
-
-
-
getSort
Gets the sort column or columns, and sort order for the
ITable
collection.
-
-
getRange
Returns the
IRange
object that represents the range to which thespecified table object applies.
-
getDataRange
Returns the
IRange
object that represents the range that contains thedata area in the table between the header row and the insert row.
-
-
getTotalsRange
Returns the
IRange
object that represents the Total row, if any, froma specified
ITable
object.
-
getShowAutoFilter
boolean getShowAutoFilter()
Gets whether the AutoFilter is displayed.
-
setShowAutoFilter
void setShowAutoFilter(boolean value)
Sets whether the AutoFilter is displayed.
-
getShowAutoFilterDropDown
boolean getShowAutoFilterDropDown()
Gets whether the table filter button is visible.
-
setShowAutoFilterDropDown
void setShowAutoFilterDropDown(boolean value)
Sets whether the table filter button is visible.
-
-
-
getShowTableStyleColumnStripes
boolean getShowTableStyleColumnStripes()
Gets if the column stripes table style is used for the specified
ITable
object .
-
setShowTableStyleColumnStripes
void setShowTableStyleColumnStripes(boolean value)
Sets if the column stripes table style is used for the specified
ITable
object .
-
getShowTableStyleFirstColumn
boolean getShowTableStyleFirstColumn()
Gets if the first column is formatted for the specified
ITable
object.
-
setShowTableStyleFirstColumn
void setShowTableStyleFirstColumn(boolean value)
Sets if the first column is formatted for the specified
ITable
object.
-
getShowTableStyleLastColumn
boolean getShowTableStyleLastColumn()
Gets if the last column is displayed for the specified
ITable
object.
-
setShowTableStyleLastColumn
void setShowTableStyleLastColumn(boolean value)
Sets if the last column is displayed for the specified
ITable
object.
-
getShowTableStyleRowStripes
boolean getShowTableStyleRowStripes()
Gets if the row stripes table style is used for the specified
ITable
object.
-
setShowTableStyleRowStripes
void setShowTableStyleRowStripes(boolean value)
Sets if the row stripes table style is used for the specified
ITable
object.
-
getShowTotals
boolean getShowTotals()
Gets whether the total row is visible.
-
setShowTotals
void setShowTotals(boolean value)
Sets whether the total row is visible.
-
-
getRows
Returns the
ITableRows
that represents all the rows of data in the
ITable
object.
-
getTableStyle
Gets the table style for the specified
ITable
object.
-
setTableStyle
Sets the table style for the specified
ITable
object.
-
resize
The Resize method allows the
ITable
object to be resized over a newrange. No cells are inserted or moved.
- Parameters:
range
- Required IRange
.
- API Note:
- The headers must remain in the same row, and the resulting table range must overlap the original table range.
-
delete
void delete()
Deletes the
ITable
object and clears the cell data from theworksheet.
-
getBindingPath
Gets the binding path of current table.
-
setBindingPath
void setBindingPath(String value)
Sets the binding path of current table.
-
getAutoGenerateColumns
boolean getAutoGenerateColumns()
Gets whether to generate columns automatically while binding data.
-
setAutoGenerateColumns
void setAutoGenerateColumns(boolean value)
Sets whether to generate columns automatically while binding data.
-
fromJson
Generate the table from json string.
- Parameters:
json
- The JSON string representing the table.
-
toJson
Generate the string from table.
-
getExpandBoundRows
boolean getExpandBoundRows()
Gets whether to add/delete entire rows on data binding.
-
setExpandBoundRows
void setExpandBoundRows(boolean value)
Sets whether to add/delete entire rows on data binding.
-
convertToRange
void convertToRange()
Convert the range of cells that made up the table to a regular range of data.