Package com.grapecity.documents.excel

Interface IPivotCache

public interface IPivotCache
Represents the memory cache for a PivotTable report.

  • Method Summary

    Modifier and Type
    Method
    Description
    IPivotTable
    createPivotTable(IRange TableDestination)
    Creates a PivotTable report based on a PivotCache object.
    IPivotTable
    createPivotTable(IRange TableDestination, String TableName)
    Creates a PivotTable report based on a PivotCache object.
    int
    getIndex()
    Returns the index number of the object within the collection of similar objects.
    int
    getRecordCount()
    Returns the number of records in the PivotTable cache or the number of cache records that contain the specified item.
    Date
    getRefreshDate()
    Deprecated.
    This member is obsolete.
    LocalDateTime
    getRefreshLocalDateTime()
    Returns the date on which the PivotTable cache was last refreshed.
    String
    getRefreshName()
    Returns the name of the person who last refreshed the PivotTable cache.
    boolean
    getRefreshOnFileOpen()
    Gets a value indicating whether the PivotTable cache is automatically updated each time the workbook is opened.
    IRange
    getSourceData()
    Gets the data source for the PivotTable report.
    void
    refresh()
    Updates the cache of the PivotTable object.
    void
    setRefreshOnFileOpen(boolean value)
    Sets a value indicating whether the PivotTable cache is automatically updated each time the workbook is opened.
    void
    setSourceData(IRange value)
    Sets the data source for the PivotTable report.

  • Method Details

    • getIndex

      int getIndex()
      Returns the index number of the object within the collection of similar objects.

    • getRecordCount

      int getRecordCount()
      Returns the number of records in the PivotTable cache or the number of cache records that contain the specified item.

    • getRefreshDate

      @Deprecated Date getRefreshDate()
      Deprecated.
      This member is obsolete. Use getRefreshLocalDateTime() instead.
      Returns the date on which the PivotTable cache was last refreshed.

    • getRefreshLocalDateTime

      LocalDateTime getRefreshLocalDateTime()
      Returns the date on which the PivotTable cache was last refreshed.

    • getRefreshName

      String getRefreshName()
      Returns the name of the person who last refreshed the PivotTable cache.

    • getSourceData

      IRange getSourceData()
      Gets the data source for the PivotTable report.

    • setSourceData

      void setSourceData(IRange value)
      Sets the data source for the PivotTable report.

    • createPivotTable

      IPivotTable createPivotTable(IRange TableDestination)
      Creates a PivotTable report based on a PivotCache object.
      Parameters:
      TableDestination - The cell in the upper-left corner of the PivotTable report’sdestination range (the range on the worksheet where the resulting PivotTable report will be placed). The destination range must be on a worksheet in the workbook that contains the PivotCache object specified by expression.

    • createPivotTable

      IPivotTable createPivotTable(IRange TableDestination, String TableName)
      Creates a PivotTable report based on a PivotCache object.
      Parameters:
      TableDestination - The cell in the upper-left corner of the PivotTable report’sdestination range (the range on the worksheet where the resulting PivotTable report will be placed). The destination range must be on a worksheet in the workbook that contains the PivotCache object specified by expression.
      TableName - The name of the new PivotTable report.

    • refresh

      void refresh()
      Updates the cache of the PivotTable object.

    • getRefreshOnFileOpen

      boolean getRefreshOnFileOpen()
      Gets a value indicating whether the PivotTable cache is automatically updated each time the workbook is opened. Default value is false.

    • setRefreshOnFileOpen

      void setRefreshOnFileOpen(boolean value)
      Sets a value indicating whether the PivotTable cache is automatically updated each time the workbook is opened.