PivotTableOptionsCommand Class

Represents a command to modify the IPivotTable 's options.

Inheritance

object

Command

PivotTableCommand

PivotTableOptionsCommand

Implements

IDisposable

Namespace: GrapeCity.Spreadsheet.Commands.PivotTables

Assembly: GrapeCity.Spreadsheet.dll

Syntax

public class PivotTableOptionsCommand : PivotTableCommand, IDisposable

Public Class PivotTableOptionsCommand
    Inherits PivotTableCommand
    Implements IDisposable

Properties

Name	Description
AllowMultipleFilters	Gets or sets a boolean value indicating whether a PivotField can have multiple filters applied to it at the same time.
AlternativeText	Gets or sets the descriptive (alternative) text string for the specified PivotTable.
ColGrand	Gets or sets a boolean value whether the PivotTable report shows grand totals for columns.
CompactRowIndent	Gets or sets the indent increment for PivotItems when compact row layout form is turned on.
DisplayErrorString	Get or set whether this PivotTable can display the error string. `true` if the PivotTable report displays a custom string in cells that contain error values.
DisplayFieldCaptions	Gets or sets a boolean value indicating whether filter buttons and IPivotField captions for rows and columns are displayed in the grid.
DisplayNullString	Get or set whether this PivotTable can display the null string. `true` if the PivotTable report displays a custom string in cells that contain null values.
ErrorString	Get or sets a String value that represents the string displayed in cells that contain errors when the DisplayErrorString property is `true` .
FieldListSortAscending	Gets or sets a boolean value indicating the sort order of fields in the PivotTable Field List. If FieldListSortAscending is set to `true` the fields are sorted in ascending order; otherwise, the fields are sorted in data source order.
HasAutoFormat	Get or set a boolean value indicating whether this PivotTable can have auto format. `true` if the PivotTable report is automatically formatted when it’s refreshed or when fields are moved.
HideSubtotals	Gets or sets a boolean value indicating whether the PivotTable's subtotals is hidden.
InsertBlankLine	Gets or sets a boolean value indicating whether a blank row is inserted after the specified row field in a PivotTable report.
MergeLabels	Get or set a boolean value indicating whether this PivotTable use merged-cell outer-row item, column item, subtotal, and grand total labels. `true` if the specified PivotTable report's outer-row item, column item, subtotal, and grand total labels use merged cells.
Name	Get or set a string value representing the name of the object.
NullString	Get or sets the string displayed in cells that contain null values when the DisplayNullString property is `true` .
PageFieldOrder	Gets or sets a Order value indicating the order in which page fields are added to the PivotTable report's layout.
PageFieldWrapCount	Gets or sets the number of page fields in each column or row in the PivotTable report.
PrintDrillIndicators	Gets or sets a boolean value whether drill indicators are printed with the PivotTable. If PrintDrillIndicators is set to `true` the drill indicators are printed with the PivotTable; otherwise, drill indicators are not printed with the PivotTable.
RefreshOnFileOpen	Gets or sets a value indicating whether the PivotTable cache is automatically updated each time the workbook is opened.
RepeatAllLabels	Gets or sets repeat item labels for all PivotFields in the specified PivotTable.
RowAxisLayout	Gets or sets setting layout options for all existing IPivotFields.
RowGrand	Gets or sets a boolean value whether the PivotTable report shows grand totals for rows.
RowsColumnsGrand	Gets or sets a boolean value whether the PivotTable report shows grand totals for rows and columns.
ShowDrillIndicators	Gets or sets a boolean value indicating the display of drill indicators. If ShowDrillIndicators is set to `true`, drill indicators will be displayed; otherwise, drill indicators will be hidden.
ShowSubtotalsAtTop	Gets or sets a boolean value indicating whether the PivotTable's subtotals is showned at top.
ShowValuesRow	Gets or sets whether the values row is displayed.
Summary	Gets or sets the description associated with the alternative text string for the specified PivotTable

Methods

Name	Description
BeforeExecute(bool)	Invoked before execute the command.
ExecuteCore(ref CommandResult, bool)	Executes this command.
SaveUndoStateCore()	Saves the data for undoing.
ToggleTableStyleBannedColumn(IPivotTable)
ToggleTableStyleBannedRow(IPivotTable)
ToggleTableStyleColumnHeaders(IPivotTable)
ToggleTableStyleRowHeaders(IPivotTable)
Undo(bool)	Undoes this command.