Class PivotSchemaDesigner

This control provides an Excel like environment to the PivotTable. This enables UI interactive feature for fields between different areas like column, row, value and filter.

Inheritance

System.Object

PivotSchemaDesigner

Namespace: Syncfusion.Windows.Controls.PivotSchemaDesigner

Assembly: Syncfusion.PivotAnalysis.WPF.dll

Syntax

[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class PivotSchemaDesigner : Control

Constructors

PivotSchemaDesigner()

Constructor for PivotSchemaDesigner to define its operations through UI commands.

Declaration

public PivotSchemaDesigner()

Fields

CustomSummaryBaseCollectionProperty

Identifies the CustomSummaryBaseCollection dependency property.

Declaration

public static readonly DependencyProperty CustomSummaryBaseCollectionProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the CustomSummaryBaseCollection dependency property.

DisplayFieldsListProperty

Identifies the DisplayFieldsList dependency property.

Declaration

public static readonly DependencyProperty DisplayFieldsListProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the DisplayFieldsList dependency property.

PivotControlProperty

Identifies the PivotControl dependency property.

Declaration

public static readonly DependencyProperty PivotControlProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the PivotControl dependency property.

ShowDisplayFieldsOnlyProperty

Identifies the ShowDisplayFieldsOnly dependency property.

Declaration

public static readonly DependencyProperty ShowDisplayFieldsOnlyProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the ShowDisplayFieldsOnly dependency property.

VisualStyleProperty

Identifies the VisualStyle dependency property.

Declaration

public static readonly DependencyProperty VisualStyleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the VisualStyle dependency property.

Properties

CustomSummaryBaseCollection

Gets or sets the custom SummaryBase collection to use in PivotComputationInformation dialog.

Declaration

public ObservableCollection<SummaryBase> CustomSummaryBaseCollection { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<SummaryBase>

DeferLayoutUpdateButton

Gets or sets the value to update the PivotTable on-demand by clicking on it.

Declaration

public Button DeferLayoutUpdateButton { get; set; }

Property Value

Type
System.Windows.Controls.Button

DeferLayoutUpdateCheckBox

Gets or sets the value to add, remove and move fields around without updating the PivotTable by checking it.

Declaration

public CheckBox DeferLayoutUpdateCheckBox { get; set; }

Property Value

Type
System.Windows.Controls.CheckBox

DisplayFieldsList

Gets or sets a list indicating which fields to be shown in PivotTable Field List.

Declaration

public List<string> DisplayFieldsList { get; set; }

Property Value

Type
System.Collections.Generic.List<System.String>

FilterList

Gets or sets the collection of filter fields to be displayed in the Report Filter of PivotSchemaDesigner.

Declaration

public ListBox FilterList { get; set; }

Property Value

Type
System.Windows.Controls.ListBox

Filters

Gets or sets the filters collection.

Declaration

public ObservableCollection<FilterItemsCollection> Filters { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<FilterItemsCollection>

PivotCalculationList

Gets or sets the collection of PivotCalculation fields to be displayed in the values label of PivotSchemaDesigner.

Declaration

public ListBox PivotCalculationList { get; set; }

Property Value

Type
System.Windows.Controls.ListBox

PivotColumnList

Gets or sets the collection of PivotColumns to be displayed in the column label of PivotSchemaDesigner.

Declaration

public ListBox PivotColumnList { get; set; }

Property Value

Type
System.Windows.Controls.ListBox

PivotControl

Gets or sets the Pivot control.

Declaration

public IPivotControl PivotControl { get; set; }

Property Value

Type
IPivotControl

PivotRowList

Gets or sets the collection of PivotRows to be displayed in the row label of PivotSchemaDesigner.

Declaration

public ListBox PivotRowList { get; set; }

Property Value

Type
System.Windows.Controls.ListBox

PivotTableFieldList

Gets or sets the collection of PivotFields to be displayed in the PivotTable Field List of PivotSchemaDesigner.

Declaration

public ListBox PivotTableFieldList { get; set; }

Property Value

Type
System.Windows.Controls.ListBox

PivotTableFields

Gets or sets the collection of PivotItems present in the PivotTableFields.

Declaration

public ObservableCollection<PivotTableField> PivotTableFields { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<PivotTableField>

ShowCalculationsAsColumnCheckBox

Gets or sets the value to show the calculations as columns.

Declaration

public CheckBox ShowCalculationsAsColumnCheckBox { get; set; }

Property Value

Type
System.Windows.Controls.CheckBox

ShowDisplayFieldsOnly

Gets or sets a value indicating whether to show only DisplayFields.

Declaration

public bool ShowDisplayFieldsOnly { get; set; }

Property Value

Type
System.Boolean

VisualStyle

Specifies the visual style for PivotSchemaDesigner.

Declaration

public PivotGridVisualStyle VisualStyle { get; set; }

Property Value

Type
PivotGridVisualStyle

Methods

ArrangeOverride(Size)

An overridden method to arrange and size the content of a PivotSchemaDesigner object.

Declaration

protected override Size ArrangeOverride(Size arrangeBounds)

Parameters

Type	Name	Description
System.Windows.Size	arrangeBounds	Computed size that is used to arrange the content.

Returns

Type	Description
System.Windows.Size	Size of the control.

DeleteFilterCanExecute(Object, CanExecuteRoutedEventArgs)

A method that determines whether to remove filter item or not.

Declaration

public void DeleteFilterCanExecute(object sender, CanExecuteRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.CanExecuteRoutedEventArgs	e	The System.Windows.Input.CanExecuteRoutedEventArgs instance containing the event data.

DeleteFilterExecuted(Object, ExecutedRoutedEventArgs)

A method that executes when the filter is deleted.

Declaration

public void DeleteFilterExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

DeletePivotItemCanExecute(Object, CanExecuteRoutedEventArgs)

A method that determines whether to delete a PivotItem or not.

Declaration

public void DeletePivotItemCanExecute(object sender, CanExecuteRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.CanExecuteRoutedEventArgs	e	The System.Windows.Input.CanExecuteRoutedEventArgs instance containing the event data.

DeletePivotItemExecuted(Object)

Deletes the PivotItem executed.

Declaration

public void DeletePivotItemExecuted(object sender)

Parameters

Type	Name	Description
System.Object	sender	The sender.

DeletePivotItemExecuted(Object, ExecutedRoutedEventArgs)

A method that executes on deleting a PivotItem.

Declaration

public void DeletePivotItemExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

Dispose()

Releases all the resources used by this component.

Declaration

public void Dispose()

FindVisualChild<childItem>(DependencyObject)

Finds the visual child.

Declaration

public static childItem FindVisualChild<childItem>(DependencyObject obj)
    where childItem : DependencyObject

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The dependency object.

Returns

Type	Description
childItem	The child item.

Type Parameters

Name	Description
childItem	The type of the child item.

InitializePivotTableList()

Binds the Pivot control ItemSource property descriptor to the PivotTableList.

Declaration

public void InitializePivotTableList()

MovetoColumnLabelsExecuted(Object, ExecutedRoutedEventArgs)

A method that executes on moving a PivotItem into column labels.

Declaration

public void MovetoColumnLabelsExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

MovetoFilterLabelsExecuted(Object, ExecutedRoutedEventArgs)

A method that executes on moving a PivotItem into filter labels.

Declaration

public void MovetoFilterLabelsExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

MovetoRowLabelsExecuted(Object, ExecutedRoutedEventArgs)

A method that executes on moving a PivotItem into row labels.

Declaration

public void MovetoRowLabelsExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

MovetoValuesExecuted(Object, ExecutedRoutedEventArgs)

A method that executes on moving a PivotItem into value labels.

Declaration

public void MovetoValuesExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

OnApplyTemplate()

An overridden method that applies template and visual style to PivotSchemaDesigner.

Declaration

public override void OnApplyTemplate()

RemoveFieldExecuted(Object, ExecutedRoutedEventArgs)

A method that executes on removing/deleting a PivotItem.

Declaration

public void RemoveFieldExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.

ShowFilterCanExecute(Object, CanExecuteRoutedEventArgs)

A method that determines whether to show filter pop-up or not.

Declaration

public void ShowFilterCanExecute(object sender, CanExecuteRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.CanExecuteRoutedEventArgs	e	The System.Windows.Input.CanExecuteRoutedEventArgs instance containing the event data.

ShowFilterExecuted(Object, ExecutedRoutedEventArgs)

A method that executes when the filter pop-up is shown.

Declaration

public void ShowFilterExecuted(object sender, ExecutedRoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
System.Windows.Input.ExecutedRoutedEventArgs	e	The System.Windows.Input.ExecutedRoutedEventArgs instance containing the event data.