Class SfPivotClient

Represents a pivot client control that displays chart and grid based on OLAP data.

Inheritance
System.Object
SfPivotClient
Namespace: Syncfusion.UI.Xaml.PivotClient
Assembly: Syncfusion.SfPivotClient.UWP.dll
Syntax
public sealed class SfPivotClient : Control

Constructors

SfPivotClient()

Initializes a new instance of the SfPivotClient class.

Declaration
public SfPivotClient()

Fields

AddReportButtonVisibilityProperty

Identifies the AddReportButtonVisibility dependency property.

Declaration
public static DependencyProperty AddReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AdvancedFilterProperty

Identifies the EnableAdvancedFilter dependency property.

Declaration
public static DependencyProperty AdvancedFilterProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AllowExcelLikeSummaryProperty

Identifies the AllowExcelLikeSummary dependency property.

Declaration
public static DependencyProperty AllowExcelLikeSummaryProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

AllowMultiFunctionalSortFilterProperty

Identifies the AllowMultiFunctionalSortFilter dependency property.

Declaration
public static DependencyProperty AllowMultiFunctionalSortFilterProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

CalculatedFieldButtonVisibilityProperty

Identifies the Syncfusion.UI.Xaml.PivotClient.SfPivotClient.CalculatedField dependency property.

Declaration
public static DependencyProperty CalculatedFieldButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ChartToolBarVisibilityProperty

Identifies the ChartToolBarVisibility dependency property.

Declaration
public static DependencyProperty ChartToolBarVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ChartToolTipButtonVisibilityProperty

Identifies the ChartToolTipButtonVisibility dependency property.

Declaration
public static DependencyProperty ChartToolTipButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ColumnAxisElementBuilderVisibilityProperty

Dependency property for ColumnAxisElementBuilderVisibility property.

Declaration
public static DependencyProperty ColumnAxisElementBuilderVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

CubeDimensionBrowserVisibilityProperty

Dependency property for CubeDimensionBrowserVisibility property.

Declaration
public static DependencyProperty CubeDimensionBrowserVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

CubeSelectorButtonVisibilityProperty

Identifies the CubeSelectorButtonVisibility dependency property.

Declaration
public static DependencyProperty CubeSelectorButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

CustomSummaryButtonVisibilityProperty

Identifies the Syncfusion.UI.Xaml.PivotClient.SfPivotClient.CustomSummary dependency property.

Declaration
public static DependencyProperty CustomSummaryButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

DisplayModeProperty

Using a DependencyProperty as the backing store for DisplayMode. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty DisplayModeProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableCalculatedMembersProperty

Identifies the EnableCalculatedMembers dependency property.

Declaration
public static DependencyProperty EnableCalculatedMembersProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableConditionalFormatProperty

Identifies the Syncfusion.UI.Xaml.PivotClient.SfPivotClient.CondtionalFormatEditorVisibility dependency property.

Declaration
public static DependencyProperty EnableConditionalFormatProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableMeasureGroupsProperty

Identifies the EnableMeasureGroupsProperty dependency property.

Declaration
public static DependencyProperty EnableMeasureGroupsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableMemberEditorPagingProperty

Identifies the EnableMemberEditorPaging dependency property.

Declaration
public static DependencyProperty EnableMemberEditorPagingProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnablePagingProperty

Using a DependencyProperty as the backing store for EnablePaging. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty EnablePagingProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

EnableVirtualKpiProperty

Identifies the EnableVirtualKpi dependency property.

Declaration
public static DependencyProperty EnableVirtualKpiProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExpanderButtonVisibilityProperty

Identifies the ExpanderButtonVisibility dependency property.

Declaration
public static DependencyProperty ExpanderButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportChartToImageButtonVisibilityProperty

Identifies the ExportChartToImageButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportChartToImageButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportPivotChartToPdfButtonVisibilityProperty

Identifies the ExportPivotChartToPdfButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportPivotChartToPdfButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportPivotChartToWordButtonVisibilityProperty

Identifies the ExportPivotChartToWordButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportPivotChartToWordButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportPivotGridToCsvButtonVisibilityProperty

Identifies the ExportPivotGridToCsvButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportPivotGridToCsvButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportPivotGridToExcelButtonVisibilityProperty

Identifies the ExportPivotGridToExcelButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportPivotGridToExcelButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportPivotGridToPdfButtonVisibilityProperty

Identifies the ExportPivotGridToPdfButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportPivotGridToPdfButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExportPivotGridToWordButtonVisibilityProperty

Identifies the ExportPivotGridToWordButtonVisibility dependency property.

Declaration
public static DependencyProperty ExportPivotGridToWordButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ExpressionFieldButtonVisibilityProperty

Identifies the Syncfusion.UI.Xaml.PivotClient.SfPivotClient.ExpressionField dependency property.

Declaration
public static DependencyProperty ExpressionFieldButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

FiltersProperty

Identifies the Filters dependency property.

Declaration
public static DependencyProperty FiltersProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

FreezeHeaderButtonVisibilityProperty

Identifies the FreezeHeaderButtonVisibility dependency property.

Declaration
public static DependencyProperty FreezeHeaderButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

FullScreenButtonVisibilityProperty

Using a DependencyProperty as the backing store for FullScreenButtonVisibility. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty FullScreenButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

GridToolBarVisibilityProperty

Identifies the GridToolBarVisibility dependency property.

Declaration
public static DependencyProperty GridToolBarVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

HyperlinkButtonVisibilityProperty

Identifies the HyperlinkButtonVisibility dependency property.

Declaration
public static DependencyProperty HyperlinkButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ItemsSourceProperty

Identifies the ItemSource dependency property.

Declaration
public static DependencyProperty ItemsSourceProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

LegendButtonVisibilityProperty

Identifies the LegendButtonVisibility dependency property.

Declaration
public static DependencyProperty LegendButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

LoadReportButtonVisibilityProperty

Identifies the LoadReportButtonVisibility dependency property.

Declaration
public static DependencyProperty LoadReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

MDXQueryButtonVisibilityProperty

Identifies the MDXQueryButtonVisibility dependency property.

Declaration
public static DependencyProperty MDXQueryButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

MemberEditorPageSizeProperty

Identifies the MemberEditorPageSize dependency property.

Declaration
public static DependencyProperty MemberEditorPageSizeProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

NewReportButtonVisibilityProperty

Identifies the NewReportButtonVisibility dependency property.

Declaration
public static DependencyProperty NewReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

OlapDataManagerProperty

Using a DependencyProperty as the backing store for OlapDataManager. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty OlapDataManagerProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PagerButtonVisibilityProperty

Identifies the PagerButtonVisibility dependency property.

Declaration
public static DependencyProperty PagerButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotCalculationsProperty

Identifies the PivotCalculations dependency property.

Declaration
public static DependencyProperty PivotCalculationsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotColumnsProperty

Identifies the PivotColumns dependency property.

Declaration
public static DependencyProperty PivotColumnsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotRowsProperty

Identifies the PivotRows dependency property.

Declaration
public static DependencyProperty PivotRowsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotSchemaDesignerButtonVisibilityProperty

Using a DependencyProperty as the backing store for FullScreenButtonVisibility. This enables animation, styling, binding, etc...

Declaration
public static DependencyProperty PivotSchemaDesignerButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

PivotSchemaDesignerVisibilityProperty

Identifies the PivotSchemaDesignerVisibility dependency property.

Declaration
public static DependencyProperty PivotSchemaDesignerVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

RemoveReportButtonVisibilityProperty

Identifies the RemoveReportButtonVisibility dependency property.

Declaration
public static DependencyProperty RemoveReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

RenameReportButtonVisibilityProperty

Identifies the RenameReportButtonVisibility dependency property.

Declaration
public static DependencyProperty RenameReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ReportListVisibilityProperty

Identifies the ReportListVisibility dependency property.

Declaration
public static DependencyProperty ReportListVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ReportMenuButtonVisibilityProperty

Identifies the ReportMenuButtonVisibilityProperty dependency property.

Declaration
public static DependencyProperty ReportMenuButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

RowAxisElementBuilderVisibilityProperty

Dependency property for RowAxisElementBuilderVisibility property.

Declaration
public static DependencyProperty RowAxisElementBuilderVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SaveAsReportButtonVisibilityProperty

Identifies the SaveAsReportButtonVisibility dependency property.

Declaration
public static DependencyProperty SaveAsReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SaveReportButtonVisibilityProperty

Identifies the SaveReportButtonVisibility dependency property.

Declaration
public static DependencyProperty SaveReportButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SearchBoxVisibilityProperty

Dependency property for SearchBoxVisibility property.

Declaration
public static DependencyProperty SearchBoxVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowCalculationsAsColumnsProperty

Identifies the ShowCalculationsAsColumns dependency property.

Declaration
public static DependencyProperty ShowCalculationsAsColumnsProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowProcessingBarProperty

Identifies the ShowProcessingBar dependency property.

Declaration
public static DependencyProperty ShowProcessingBarProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowSubTotalsButtonVisibilityProperty

Identifies the ShowSubTotalsButtonVisibility dependency property.

Declaration
public static DependencyProperty ShowSubTotalsButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SlicerAxisElementBuilderVisibilityProperty

Dependency property for SlicerAxisElementBuilderVisibility property.

Declaration
public static DependencyProperty SlicerAxisElementBuilderVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

TogglePivotButtonVisibilityProperty

Identifies the TogglePivotButtonVisibility dependency property.

Declaration
public static DependencyProperty TogglePivotButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ToolBarVisibilityProperty

Identifies the ToolBarVisibility dependency property.

Declaration
public static DependencyProperty ToolBarVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ValueAxisElementBuilderVisibilityProperty

Dependency property for ValueAxisElementBuilderVisibility property.

Declaration
public static DependencyProperty ValueAxisElementBuilderVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ValueCellToolTipButtonVisibilityProperty

Identifies the ValueCellToolTipButtonVisibility dependency property.

Declaration
public static DependencyProperty ValueCellToolTipButtonVisibilityProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

Properties

AddReportButtonVisibility

Gets or sets a value indicating whether the add report button in client toolbar is visible or not.

Declaration
public Visibility AddReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

AllowExcelLikeSummary

Gets or sets the value to set the SummaryType as Normal or Excel_like

Declaration
public bool AllowExcelLikeSummary { get; set; }
Property Value
Type
System.Boolean

AllowMultiFunctionalSortFilter

Gets or sets whether excel-like filtering in axis element builder is enabled or not.

Declaration
public bool AllowMultiFunctionalSortFilter { get; set; }
Property Value
Type
System.Boolean

CalculatedFieldButtonVisibility

Gets or sets a value indicating whether the Add Expression Field button in client toolbar is visible or not.

Declaration
public Visibility CalculatedFieldButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ChartToolBarVisibility

Gets or sets a value indicating whether the chart toolbar is visible or not.

Declaration
public Visibility ChartToolBarVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ChartToolTipButtonVisibility

Gets or sets a value indicating whether the tool-tip button in chart toolbar is visible or not.

Declaration
public Visibility ChartToolTipButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ColumnAxisElementBuilderVisibility

Gets or sets the visibility of column axis element builder.

Declaration
public Visibility ColumnAxisElementBuilderVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

CubeDimensionBrowserVisibility

Gets or sets the visibility of the cube dimension browser.

Declaration
public Visibility CubeDimensionBrowserVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

CubeSelectorButtonVisibility

Gets or sets a value indicating whether the cube selector button in client toolbar is visible or not.

Declaration
public Visibility CubeSelectorButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

CustomSummaryButtonVisibility

Gets or sets a value indicating whether the Add Expression Field button in client toolbar is visible or not.

Declaration
public Visibility CustomSummaryButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

DisplayMode

Gets or sets the value to display the chart or grid or both based on the mode.

Declaration
public PivotClientDisplayMode DisplayMode { get; set; }
Property Value
Type
PivotClientDisplayMode

EnableAdvancedFilter

Gets or sets a value to indicate whether the multi functional filter should be enabled or not.

Declaration
public bool EnableAdvancedFilter { get; set; }
Property Value
Type
System.Boolean

EnableAutoExecute

Gets or sets whether the elements will automatically execute the query.

Declaration
public bool EnableAutoExecute { get; set; }
Property Value
Type Description
System.Boolean

true if [auto execute]; otherwise, false.

EnableCalculatedMembers

Gets or sets a value indicating whether the calculated members should be enabled or not.

Declaration
public bool EnableCalculatedMembers { get; set; }
Property Value
Type
System.Boolean

EnableConditionalFormat

Gets or sets a value indicating whether the conditional format editor button in grid toolbar is visible or not.

Declaration
public bool EnableConditionalFormat { get; set; }
Property Value
Type
System.Boolean

EnableMeasureGroups

Gets or sets a value indicating whether to enable the measure groups visibility or not.

Declaration
public bool EnableMeasureGroups { get; set; }
Property Value
Type
System.Boolean

EnableMemberEditorPaging

Gets or sets a value indicating whether the member editor paging should be enabled or not.

Declaration
public bool EnableMemberEditorPaging { get; set; }
Property Value
Type
System.Boolean

EnablePaging

Gets or sets a value to indicate whether the paging should be enabled or not.

Declaration
public bool EnablePaging { get; set; }
Property Value
Type
System.Boolean

EnableVirtualKpi

Gets or sets a value to indicate whether the virtual KPI should be enabled or not.

Declaration
public bool EnableVirtualKpi { get; set; }
Property Value
Type
System.Boolean

ExpanderButtonVisibility

Gets or sets a value indicating whether the expander button in client toolbar is visible or not.

Declaration
public Visibility ExpanderButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportChartToImageButtonVisibility

Gets or sets a value indicating whether the export to chart button in chart toolbar is visible or not.

Declaration
public Visibility ExportChartToImageButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportPivotChartToPdfButtonVisibility

Gets or sets a value indicating whether the export to PDF button in chart toolbar is visible or not.

Declaration
public Visibility ExportPivotChartToPdfButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportPivotChartToWordButtonVisibility

Gets or sets a value indicating whether the export to word button in chart toolbar is visible or not.

Declaration
public Visibility ExportPivotChartToWordButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportPivotGridToCsvButtonVisibility

Gets or sets a value indicating whether the export to CSV button in grid toolbar is visible or not.

Declaration
public Visibility ExportPivotGridToCsvButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportPivotGridToExcelButtonVisibility

Gets or sets a value indicating whether the export to excel button in grid toolbar is visible or not.

Declaration
public Visibility ExportPivotGridToExcelButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportPivotGridToPdfButtonVisibility

Gets or sets a value indicating whether the export to PDF button in grid toolbar is visible or not.

Declaration
public Visibility ExportPivotGridToPdfButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExportPivotGridToWordButtonVisibility

Gets or sets a value indicating whether the export to word button in grid toolbar is visible or not.

Declaration
public Visibility ExportPivotGridToWordButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ExpressionFieldButtonVisibility

Gets or sets a value indicating whether the Add Expression Field button in client toolbar is visible or not.

Declaration
public Visibility ExpressionFieldButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

Filters

Gets or sets the collection of filter expressions when using relational data source.

Declaration
public ObservableCollection<FilterExpression> Filters { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<FilterExpression>

FreezeHeaderButtonVisibility

Gets or sets a value indicating whether the freeze header button in grid toolbar is visible or not.

Declaration
public Visibility FreezeHeaderButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

FullScreenButtonVisibility

Gets or sets whether full screen button can be displayed in SfPivotClient control.

Declaration
public Visibility FullScreenButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

GridToolBarVisibility

Gets or sets a value indicating whether the grid toolbar is visible or not.

Declaration
public Visibility GridToolBarVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

HyperlinkButtonVisibility

Gets or sets a value indicating whether the hyperlink button in grid toolbar is visible or not.

Declaration
public Visibility HyperlinkButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ItemsSource

Gets or sets source of data for this PivotTable. This object should be either an IEnumerable List.

Declaration
public object ItemsSource { get; set; }
Property Value
Type
System.Object

LegendButtonVisibility

Gets or sets a value indicating whether the legend button is visible or not.

Declaration
public Visibility LegendButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

LoadReportButtonVisibility

Gets or sets a value indicating whether the load report button in client toolbar is visible or not.

Declaration
public Visibility LoadReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

MDXQueryButtonVisibility

Gets or sets a value indicating whether the MDX query button in client toolbar is visible or not.

Declaration
public Visibility MDXQueryButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

MemberEditorPageSize

Gets or sets the value for the size of the member editor page.

Declaration
public int MemberEditorPageSize { get; set; }
Property Value
Type
System.Int32

NewReportButtonVisibility

Gets or sets a value indicating whether the new report button in client toolbar is visible or not.

Declaration
public Visibility NewReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

OlapDataManager

Gets or sets the OLAP data manager which manages OLAP data source.

Declaration
public OlapDataManager OlapDataManager { get; set; }
Property Value
Type
OlapDataManager

PagerButtonVisibility

Gets or sets a value indicating whether the Pager button in client toolbar is visible or not.

Declaration
public Visibility PagerButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

PivotCalculations

Gets or sets the collection of PivotCalculations when using relational data source.

Declaration
public ObservableCollection<PivotComputationInfo> PivotCalculations { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<PivotComputationInfo>

PivotChart

Gets or sets the pivot chart rendered for OLAP data.

Declaration
public SfPivotChart PivotChart { get; }
Property Value
Type
SfPivotChart

PivotColumns

Gets or sets the collection of PivotItems of PivotColumns when using the relational data source.

Declaration
public ObservableCollection<PivotItem> PivotColumns { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PivotGrid

Gets or sets the pivot chart rendered for OLAP data.

Declaration
public SfPivotGrid PivotGrid { get; }
Property Value
Type
SfPivotGrid

PivotRows

Gets or sets the collection of PivotItems of PivotRows when using relational data source

Declaration
public ObservableCollection<PivotItem> PivotRows { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<PivotItem>

PivotSchemaDesignerButtonVisibility

Gets or sets whether full screen button can be displayed in SfPivotClient control.

Declaration
public Visibility PivotSchemaDesignerButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

PivotSchemaDesignerVisibility

Gets or sets a value indicating whether the pivot schema designer is visible or not.

Declaration
public Visibility PivotSchemaDesignerVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

RemoveReportButtonVisibility

Gets or sets a value indicating whether the remove report button in client toolbar is visible or not.

Declaration
public Visibility RemoveReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

RenameReportButtonVisibility

Gets or sets a value indicating whether the rename report button in client toolbar is visible or not.

Declaration
public Visibility RenameReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ReportListVisibility

Gets or sets a value indicating whether the report list in client toolbar is visible or not.

Declaration
public Visibility ReportListVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ReportMenuButtonVisibility

Gets or sets a value indicating whether the report menu button in client toolbar is visible or not.

Declaration
public Visibility ReportMenuButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

RowAxisElementBuilderVisibility

Gets or sets the visibility of row axis element builder.

Declaration
public Visibility RowAxisElementBuilderVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

SaveAsReportButtonVisibility

Gets or sets a value indicating whether the save-as report button in client toolbar is visible or not.

Declaration
public Visibility SaveAsReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

SaveReportButtonVisibility

Gets or sets a value indicating whether the save report button in client toolbar is visible or not.

Declaration
public Visibility SaveReportButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

SearchBoxVisibility

Gets or sets the visibility of search box in cube dimension browser.

Declaration
public Visibility SearchBoxVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ShowCalculationsAsColumns

Gets or sets whether the calculations should appear as rows/columns in the PivotGrid. By default the calculations is displayed as columns.

Declaration
public bool ShowCalculationsAsColumns { get; set; }
Property Value
Type
System.Boolean

ShowProcessingBar

Gets or sets a value indicating whether the processing bar should be enabled or not.

Declaration
public bool ShowProcessingBar { get; set; }
Property Value
Type
System.Boolean

ShowSubTotalsButtonVisibility

Gets or sets a value indicating whether the show subtotals button in grid toolbar is visible or not.

Declaration
public Visibility ShowSubTotalsButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

SlicerAxisElementBuilderVisibility

Gets or sets the visibility of slicer axis element builder.

Declaration
public Visibility SlicerAxisElementBuilderVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

TogglePivotButtonVisibility

Gets or sets a value indicating whether the toggle-pivot button in client toolbar is visible or not.

Declaration
public Visibility TogglePivotButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ToolBarVisibility

Gets or sets a value indicating whether the client toolbar is visible or not.

Declaration
public Visibility ToolBarVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ValueAxisElementBuilderVisibility

Gets or sets the visibility of value axis element builder.

Declaration
public Visibility ValueAxisElementBuilderVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

ValueCellToolTipButtonVisibility

Gets or sets a value indicating whether the value cell tooltip button in grid toolbar is visible or not.

Declaration
public Visibility ValueCellToolTipButtonVisibility { get; set; }
Property Value
Type
Windows.UI.Xaml.Visibility

Methods

add_BeforeLoadReport(BeforeLoadReportHandler)

Declaration
public void add_BeforeLoadReport(BeforeLoadReportHandler value)
Parameters
Type Name Description
BeforeLoadReportHandler value

add_BeforeSaveReport(BeforeSaveReportHandler)

Declaration
public void add_BeforeSaveReport(BeforeSaveReportHandler value)
Parameters
Type Name Description
BeforeSaveReportHandler value

add_ChartToPdfExporting(ExportingChartEventHandler)

Declaration
public void add_ChartToPdfExporting(ExportingChartEventHandler value)
Parameters
Type Name Description
ExportingChartEventHandler value

add_ChartToWordExporting(ExportingChartEventHandler)

Declaration
public void add_ChartToWordExporting(ExportingChartEventHandler value)
Parameters
Type Name Description
ExportingChartEventHandler value

add_DrillThroughOccurred(DrillThroughHandler)

Declaration
public void add_DrillThroughOccurred(DrillThroughHandler value)
Parameters
Type Name Description
DrillThroughHandler value

add_GridToExcelExporting(ExportingGridEventHandler)

Declaration
public void add_GridToExcelExporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

add_GridToPdfExporting(ExportingGridEventHandler)

Declaration
public void add_GridToPdfExporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

add_GridToWordExporting(ExportingGridEventHandler)

Declaration
public void add_GridToWordExporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

add_MeasureGroupsChanged(MeasureGroupsChangedEventHandler)

Declaration
public void add_MeasureGroupsChanged(MeasureGroupsChangedEventHandler value)
Parameters
Type Name Description
MeasureGroupsChangedEventHandler value

add_MemberEditorPageNavigated(MemberEditorPageNavigatedHandler)

Declaration
public void add_MemberEditorPageNavigated(MemberEditorPageNavigatedHandler value)
Parameters
Type Name Description
MemberEditorPageNavigatedHandler value

add_RefreshCompleted(RefreshCompletedEventHandler)

Declaration
public void add_RefreshCompleted(RefreshCompletedEventHandler value)
Parameters
Type Name Description
RefreshCompletedEventHandler value

add_RefreshStarted(RefreshStartedEventHandler)

Declaration
public void add_RefreshStarted(RefreshStartedEventHandler value)
Parameters
Type Name Description
RefreshStartedEventHandler value

AddReport()

Add the new report to the report list.

Declaration
public void AddReport()

CreateNewSession()

Creates the new session.

Declaration
public void CreateNewSession()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

LoadReportDefinition()

Loads the report definition.

Declaration
public void LoadReportDefinition()

OnApplyTemplate()

Builds the visual tree for this control when a new template is applied.

Declaration
protected override void OnApplyTemplate()

RaiseMeasureGroupsChanged(Object, MeasureGroupsChangedEventArgs)

Raises the MeasureGroupsChanged event.

Declaration
public void RaiseMeasureGroupsChanged(object sender, MeasureGroupsChangedEventArgs args)
Parameters
Type Name Description
System.Object sender

The SfPivotClient control.
MeasureGroupsChangedEventArgs args

The MeasureGroupsChangedEventArgs contains the event data.

RaiseMemberEditorPageNavigated(MemberEditorPageNavigatedEventArgs)

Raises the Syncfusion.UI.Xaml.PivotClient.MemberEditorPageNavigated event.

Declaration
public void RaiseMemberEditorPageNavigated(MemberEditorPageNavigatedEventArgs args)
Parameters
Type Name Description
MemberEditorPageNavigatedEventArgs args

The data for the event.

RaiseRefreshCompleted(RefreshEventArgs)

Raising the refresh completed event for disabling loading indicator

Declaration
public void RaiseRefreshCompleted(RefreshEventArgs args)
Parameters
Type Name Description
RefreshEventArgs args

RaiseRefreshStarted(RefreshEventArgs)

Raising the refresh started event for enabling loading indicator

Declaration
public void RaiseRefreshStarted(RefreshEventArgs args)
Parameters
Type Name Description
RefreshEventArgs args

remove_BeforeLoadReport(BeforeLoadReportHandler)

Declaration
public void remove_BeforeLoadReport(BeforeLoadReportHandler value)
Parameters
Type Name Description
BeforeLoadReportHandler value

remove_BeforeSaveReport(BeforeSaveReportHandler)

Declaration
public void remove_BeforeSaveReport(BeforeSaveReportHandler value)
Parameters
Type Name Description
BeforeSaveReportHandler value

remove_ChartToPdfExporting(ExportingChartEventHandler)

Declaration
public void remove_ChartToPdfExporting(ExportingChartEventHandler value)
Parameters
Type Name Description
ExportingChartEventHandler value

remove_ChartToWordExporting(ExportingChartEventHandler)

Declaration
public void remove_ChartToWordExporting(ExportingChartEventHandler value)
Parameters
Type Name Description
ExportingChartEventHandler value

remove_DrillThroughOccurred(DrillThroughHandler)

Declaration
public void remove_DrillThroughOccurred(DrillThroughHandler value)
Parameters
Type Name Description
DrillThroughHandler value

remove_GridToExcelExporting(ExportingGridEventHandler)

Declaration
public void remove_GridToExcelExporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

remove_GridToPdfExporting(ExportingGridEventHandler)

Declaration
public void remove_GridToPdfExporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

remove_GridToWordExporting(ExportingGridEventHandler)

Declaration
public void remove_GridToWordExporting(ExportingGridEventHandler value)
Parameters
Type Name Description
ExportingGridEventHandler value

remove_MeasureGroupsChanged(MeasureGroupsChangedEventHandler)

Declaration
public void remove_MeasureGroupsChanged(MeasureGroupsChangedEventHandler value)
Parameters
Type Name Description
MeasureGroupsChangedEventHandler value

remove_MemberEditorPageNavigated(MemberEditorPageNavigatedHandler)

Declaration
public void remove_MemberEditorPageNavigated(MemberEditorPageNavigatedHandler value)
Parameters
Type Name Description
MemberEditorPageNavigatedHandler value

remove_RefreshCompleted(RefreshCompletedEventHandler)

Declaration
public void remove_RefreshCompleted(RefreshCompletedEventHandler value)
Parameters
Type Name Description
RefreshCompletedEventHandler value

remove_RefreshStarted(RefreshStartedEventHandler)

Declaration
public void remove_RefreshStarted(RefreshStartedEventHandler value)
Parameters
Type Name Description
RefreshStartedEventHandler value

SaveAsReport()

Saves the current report as XML file.

Declaration
public void SaveAsReport()

ShowOrHideExpander()

Shows or hide the expanders available in chart and grid.

Declaration
public void ShowOrHideExpander()

ToggleEnablePaging()

Swaps the EnablePaging Property value in current report

Declaration
public void ToggleEnablePaging()

TogglePivot()

Swaps the categorical and series element in the result set.

Declaration
public void TogglePivot()

Events

BeforeLoadReport

Occurs when a predefined report is going to be loaded.

Declaration
public event BeforeLoadReportHandler BeforeLoadReport
Event Type
Type
BeforeLoadReportHandler

BeforeSaveReport

Occurs when the current report is going to be saved.

Declaration
public event BeforeSaveReportHandler BeforeSaveReport
Event Type
Type
BeforeSaveReportHandler

ChartToPdfExporting

Occurs when the pivotchart exports into pdf document.

Declaration
public event ExportingChartEventHandler ChartToPdfExporting
Event Type
Type
ExportingChartEventHandler

ChartToWordExporting

Occurs when the pivotchart exports into word document.

Declaration
public event ExportingChartEventHandler ChartToWordExporting
Event Type
Type
ExportingChartEventHandler

DrillThroughOccurred

Occurs when the drill through data of the hyper link cell is obtained.

Declaration
public event DrillThroughHandler DrillThroughOccurred
Event Type
Type
DrillThroughHandler

GridToExcelExporting

Occurs when exporting to Excel begins.

Declaration
public event ExportingGridEventHandler GridToExcelExporting
Event Type
Type
ExportingGridEventHandler

GridToPdfExporting

Occurs when exporting to Pdf begins.

Declaration
public event ExportingGridEventHandler GridToPdfExporting
Event Type
Type
ExportingGridEventHandler

GridToWordExporting

Occurs when exporting to word begins.

Declaration
public event ExportingGridEventHandler GridToWordExporting
Event Type
Type
ExportingGridEventHandler

MeasureGroupsChanged

Occurs when the current MeasureGroup gets changed.

Declaration
public event MeasureGroupsChangedEventHandler MeasureGroupsChanged
Event Type
Type
MeasureGroupsChangedEventHandler

MemberEditorPageNavigated

Occurs when the member editor navigation button clicked.

Declaration
public event MemberEditorPageNavigatedHandler MemberEditorPageNavigated
Event Type
Type
MemberEditorPageNavigatedHandler

RefreshCompleted

Occurs when the SfPivotClient completed Refresh.

Declaration
public event RefreshCompletedEventHandler RefreshCompleted
Event Type
Type
RefreshCompletedEventHandler

RefreshStarted

Occurs when the SfPivotClient started to Refresh.

Declaration
public event RefreshStartedEventHandler RefreshStarted
Event Type
Type
RefreshStartedEventHandler

Extension Methods