Class PivotTable
  
  
  
  
    Inheritance
    System.Object
    PivotTable
   
  
  Assembly: DRIT.Spreadsheet.dll
  Syntax
  
    public class PivotTable : object
   
  Properties
  
  
  
  
  AltTextDescription
  Gets or sets alternative, text based representation of the description.
 
  
  Declaration
  
    public string AltTextDescription { get; set; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  AltTextTitle
  Gets or sets alternative, text based representation of the title.
 
  
  Declaration
  
    public string AltTextTitle { get; set; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  ColumnFields
  
  
  Declaration
  
    public PivotFieldCollection ColumnFields { get; }
   
  Property Value
  
  
  
  
  ColumnHeaderCaption
  Gets the string to be displayed in column header in compact mode.
 
  
  Declaration
  
    public string ColumnHeaderCaption { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  CustomListSort
  Gets whether the "custom lists" option is offered when sorting this PivotTable.
 
  
  Declaration
  
    public bool CustomListSort { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  DataFields
  
  
  Declaration
  
    public PivotFieldCollection DataFields { get; }
   
  Property Value
  
  
  
  
  DataSource
  Gets the datasource range label of the pivot table.
 
  
  Declaration
  
    public string DataSource { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  EditData
  Gets whether the user is allowed to edit the cells in the data area of the PivotTable.
 
  
  Declaration
  
    public bool EditData { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  EnableDrill
  Gets whether whether the user is prevented from drilling down on a PivotItem or aggregate value..
 
  
  Declaration
  
    public bool EnableDrill { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  EnableFieldProperties
  Gets whether the user is prevented from displaying PivotField properties.
 
  
  Declaration
  
    public bool EnableFieldProperties { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  EnableGridDropZones
  Gets whether the in-grid drop zones should be enabled.
 
  
  Declaration
  
    public bool EnableGridDropZones { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  EnableWizard
  Gets whether the user is prevented from displaying the PivotTable wizard.
 
  
  Declaration
  
    public bool EnableWizard { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ErrorCaption
  Gets the string to be displayed in cells that contain errors.
 
  
  Declaration
  
    public string ErrorCaption { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  FieldListSortAscending
  Gets whether fields in the PivotTable are sorted in non-default order in the field list.
 
  
  Declaration
  
    public bool FieldListSortAscending { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  FieldPrintTitles
  Gets whether the row and column titles from the PivotTable should be printed.
 
  
  Declaration
  
    public bool FieldPrintTitles { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  GrandTotalCaption
  Gets the string to be displayed for grand totals.
 
  
  Declaration
  
    public string GrandTotalCaption { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  Indent
  Gets the indentation increment for compact axis and can be used to set the Report Layout to Compact Form.
 
  
  Declaration
  
    public int Indent { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
  
  
  ItemPrintTitles
  Gets whether PivotItem names should be repeated at the top of each printed page.
 
  
  Declaration
  
    public bool ItemPrintTitles { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  MergeTitles
  Gets whether row or column titles that span multiple cells should be merged into a single cell.
 
  
  Declaration
  
    public bool MergeTitles { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  MissingValueString
  Gets the string to be displayed in cells with no value
 
  
  Declaration
  
    public string MissingValueString { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  MultipleFieldFilters
  Gets whether the fields of a PivotTable can have multiple filters set on them.
 
  
  Declaration
  
    public bool MultipleFieldFilters { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  Name
  Gets the PivotTable name.
 
  
  Declaration
  
    public string Name { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  PageFields
  
  
  Declaration
  
    public PivotFieldCollection PageFields { get; }
   
  Property Value
  
  
  
  
  PageFieldWrapCount
  Gets the number of page fields to display before starting another row or column.
 
  
  Declaration
  
    public int PageFieldWrapCount { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
  
  
  PageOverThenDown
  Gets how the page fields are laid out when there are multiple PivotFields in the page area.
 
  
  Declaration
  
    public bool PageOverThenDown { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
        True indicates the fields will display "Over, then down".
False indicates the fields will display "down, then Over" 
 | 
      
    
  
  
  
  
  PivotFilters
  
  
  Declaration
  
    public PivotFilterCollection PivotFilters { get; }
   
  Property Value
  
  
  
  
  
  Gets whether drill indicators should be printed.
 
  
  Declaration
  
    public bool PrintExpandCollapseButtons { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  RefreshDate
  Gets the date when the PivotTable cache was last refreshed.
 
  
  Declaration
  
    public DateTime RefreshDate { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.DateTime | 
         | 
      
    
  
  
  
  
  RefreshedByName
  Gets the name of the user who last refreshed the PivotTable cache.
 
  
  Declaration
  
    public string RefreshedByName { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  RefreshOnLoad
  Gets whether the application will refresh the cache when the workbook has been opened.
 
  
  Declaration
  
    public bool RefreshOnLoad { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  RowFields
  
  
  Declaration
  
    public PivotFieldCollection RowFields { get; }
   
  Property Value
  
  
  
  
  
  the string to be displayed in row header in compact mode.
 
  
  Declaration
  
    public string RowHeaderCaption { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  SaveData
  Gets whether the pivot records are saved with the cache.
 
  
  Declaration
  
    public bool SaveData { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowContextualToolTips
  Gets whether to show contextual tool tips.
 
  
  Declaration
  
    public bool ShowContextualToolTips { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowEmptyColumn
  Gets whether to include empty columns in the table.
 
  
  Declaration
  
    public bool ShowEmptyColumn { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowEmptyRow
  Gets whether to include empty rows in the table..
 
  
  Declaration
  
    public bool ShowEmptyRow { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowError
  Gets whether to show error messages in cells.
 
  
  Declaration
  
    public bool ShowError { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  
  Gets whether to show expand/collapse buttons.
 
  
  Declaration
  
    public bool ShowExpandCollapseButtons { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowGrandTotalsForColumns
  
  
  Declaration
  
    public bool ShowGrandTotalsForColumns { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowGrandTotalsForRows
  Gets whether grand totals should be displayed for the PivotTable rows. The default value for this attribute is true.
 
  
  Declaration
  
    public bool ShowGrandTotalsForRows { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowItemNames
  Gets whether to display item names when adding a field onto a PivotTable that has no data fields.
 
  
  Declaration
  
    public bool ShowItemNames { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  ShowMissing
  Gets whether to show a message in cells with no value.
 
  
  Declaration
  
    public bool ShowMissing { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  
  Gets or sets whether member property information is displayed in PivotTable tooltips.
 
  
  Declaration
  
    public bool ShowPropertiesInTooltips { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  SourceFields
  Gets the collection of all fields available from the data source.
 
  
  Declaration
  
    public PivotFieldCollection SourceFields { get; }
   
  Property Value
  
  
  
  
  SubtotalHiddenItems
  Gets whether data for hidden pivotItems for PivotFields in the data area should be included in subtotals.
 
  
  Declaration
  
    public bool SubtotalHiddenItems { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  TableStyle
  Gets the pivot table style to apply to the main table area of the PivotTable.
 
  
  Declaration
  
    public PivotTableStyle TableStyle { get; }
   
  Property Value
  
  
  
  
  Worksheet
  
  
  Declaration
  
    public Worksheet Worksheet { get; }
   
  Property Value