Interface
IPivotSettings

Represents an interface for controlling pivot settings like group descriptions, aggregate descriptions, etc.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
public interface IPivotSettings : INotifyPropertyChanged, ISupportInitialize

Inherited Members INotifyPropertyChanged.PropertyChangedISupportInitialize.BeginInit()ISupportInitialize.EndInit()

Properties

AggregateDescriptions

Gets the pivot aggregate descriptions list.

Declaration

cs-api-definition
IList AggregateDescriptions { get; }

Property Value

IList

AggregatesLevel

Gets or sets the position where groups for the aggregates should be placed.

Declaration

cs-api-definition
int AggregatesLevel { get; set; }

Property Value

int

AggregatesPosition

Gets or sets a value indicating where the aggregate groups should be positioned.

Declaration

cs-api-definition
PivotAxis AggregatesPosition { get; set; }

Property Value

PivotAxis

ColumnGroupDescriptions

Gets the pivot column group descriptions list.

Declaration

cs-api-definition
IList ColumnGroupDescriptions { get; }

Property Value

IList

FilterDescriptions

Gets the pivot filter descriptions list.

Declaration

cs-api-definition
IList FilterDescriptions { get; }

Property Value

IList

RowGroupDescriptions

Gets the pivot row group descriptions list.

Declaration

cs-api-definition
IList RowGroupDescriptions { get; }

Property Value

IList

Methods

BeginEdit()

Enters the IPivotSettings in a new editing scope. Use when applying multiple changes to the pivot settings. using(pivotSettings.BeginEdit()) { // Apply multiple changes to pivotSettings here. }

Declaration

cs-api-definition
IDisposable BeginEdit()

Returns

IDisposable

An edit scope token that you must Dispose() when you are done with the editing.

Events

DescriptionsChanged

An event that notifies some of the FilterDescriptions, RowGroupDescriptions, ColumnGroupDescriptions, AggregateDescriptions, AggregatesLevel or AggregatesPosition has changed. Notifications are raised even in BeginEdit() scope.

Declaration

cs-api-definition
event EventHandler<EventArgs> DescriptionsChanged

Event Value

EventHandler<EventArgs>

SettingsChanged

Notifies when this or one of the children is changed.

Declaration

cs-api-definition
event EventHandler<SettingsChangedEventArgs> SettingsChanged

Event Value

EventHandler<SettingsChangedEventArgs>