Package com.grapecity.documents.excel

Interface ITable

public interface ITable
Represents a table object on a worksheet.

  • Method Details

    • getName

      String getName()
      Gets the name of the ITable object.

    • setName

      void setName(String value)
      Sets the name of the ITable object.

    • getDisplayName

      String getDisplayName()
      Gets the display name for the specified ITable.

    • setDisplayName

      void setDisplayName(String value)
      Sets the display name for the specified ITable.

    • getComment

      String getComment()
      Gets the comment associated with the table object.

    • setComment

      void setComment(String value)
      Sets the comment associated with the table object.

    • getSort

      ISort getSort()
      Gets the sort column or columns, and sort order for the ITablecollection.

    • getAutoFilter

      IAutoFilter getAutoFilter()
      Filters a list using the IAutoFilter .

    • getRange

      IRange getRange()
      Returns the IRange object that represents the range to which thespecified table object applies.

    • getDataRange

      IRange getDataRange()
      Returns the IRange object that represents the range that contains thedata area in the table between the header row and the insert row.

    • getHeaderRange

      IRange getHeaderRange()
      Returns the IRange object that represents the range of the header rowfor a table.

    • getTotalsRange

      IRange 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.

    • getShowHeaders

      boolean getShowHeaders()
      Gets whether the header information should be displayed for the specified ITable object.

    • setShowHeaders

      void setShowHeaders(boolean value)
      Sets whether the header information should be displayed for the specified ITable object.

    • 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 ITableobject.

    • setShowTableStyleFirstColumn

      void setShowTableStyleFirstColumn(boolean value)
      Sets if the first column is formatted for the specified ITableobject.

    • 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 ITableobject.

    • setShowTableStyleRowStripes

      void setShowTableStyleRowStripes(boolean value)
      Sets if the row stripes table style is used for the specified ITableobject.

    • getShowTotals

      boolean getShowTotals()
      Gets whether the total row is visible.

    • setShowTotals

      void setShowTotals(boolean value)
      Sets whether the total row is visible.

    • getColumns

      ITableColumns getColumns()
      Returns an ITableColumns collection that represents all the columnsin the ITable object.

    • getRows

      ITableRows getRows()
      Returns the ITableRows that represents all the rows of data in theITable object.

    • getTableStyle

      ITableStyle getTableStyle()
      Gets the table style for the specified ITable object.

    • setTableStyle

      void setTableStyle(ITableStyle value)
      Sets the table style for the specified ITable object.

    • resize

      void resize(IRange range)
      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

      String 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

      void fromJson(String json)
      Generate the table from json string.
      Parameters:
      json - The JSON string representing the table.

    • toJson

      String 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.