Documentation

Interface IPivotSettings

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

Namespace: Telerik.Pivot.Core
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

public interface IPivotSettings : INotifyPropertyChanged, ISupportInitialize

Properties

AggregateDescriptions

Gets the pivot aggregate descriptions list.

Declaration
IList AggregateDescriptions { get; }
Property Value
System.Collections.IList

AggregatesLevel

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

Declaration
int AggregatesLevel { get; set; }
Property Value
System.Int32

AggregatesPosition

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

Declaration
PivotAxis AggregatesPosition { get; set; }
Property Value
PivotAxis

ColumnGroupDescriptions

Gets the pivot column group descriptions list.

Declaration
IList ColumnGroupDescriptions { get; }
Property Value
System.Collections.IList

FilterDescriptions

Gets the pivot filter descriptions list.

Declaration
IList FilterDescriptions { get; }
Property Value
System.Collections.IList

RowGroupDescriptions

Gets the pivot row group descriptions list.

Declaration
IList RowGroupDescriptions { get; }
Property Value
System.Collections.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
IDisposable BeginEdit()
Returns
System.IDisposable

An edit scope token that you must System.IDisposable.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
event EventHandler<EventArgs> DescriptionsChanged
Event Type
System.EventHandler<System.EventArgs>

SettingsChanged

Notifies when this or one of the children is changed.

Declaration
event EventHandler<SettingsChangedEventArgs> SettingsChanged
Event Type
System.EventHandler<SettingsChangedEventArgs>

Extension Methods