Class FilterEditor

Displays the members of the current hierarchy and allows to select and unselect members for filtering.

Inheritance
System.Object
FilterEditor
Namespace: Syncfusion.UI.Xaml.PivotGrid
Assembly: Syncfusion.SfPivotGrid.UWP.dll
Syntax
public class FilterEditor : Control

Constructors

FilterEditor()

Initializes a new instance of the FilterEditor class.

Declaration
public FilterEditor()

FilterEditor(Style, GroupingBarItem, ObservableCollection<MetaTreeNode>)

Initializes a new instance of the FilterEditor class.

Declaration
public FilterEditor(Style style, GroupingBarItem host, ObservableCollection<MetaTreeNode> metaTreeNodes)
Parameters
Type Name Description
Windows.UI.Xaml.Style style

The style of filter editor.
GroupingBarItem host

The split button that hosts the filter editor.
System.Collections.ObjectModel.ObservableCollection<MetaTreeNode> metaTreeNodes

The collection of nodes available in the filter editor.

FilterEditor(Style, GroupingBarItem, Object)

Initializes a new instance of the FilterEditor class.

Declaration
public FilterEditor(Style style, GroupingBarItem host, object metaData)
Parameters
Type Name Description
Windows.UI.Xaml.Style style

The style of filter editor.
GroupingBarItem host

The split button that hosts the filter editor.
System.Object metaData

The current node.

Properties

FilterList

Gets or sets the collection of filter items in the filter list-box.

Declaration
public FilterItemsCollection FilterList { get; set; }
Property Value
Type Description
FilterItemsCollection

The filter list.

Filters

Gets or sets the collection of filters.

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

The filters.

Host

Gets or sets the split button that hosts the filter editor.

Declaration
public GroupingBarItem Host { get; set; }
Property Value
Type Description
GroupingBarItem

MetaTreeNodes

Gets or sets the collection of nodes available in the filter editor.

Declaration
public ObservableCollection<MetaTreeNode> MetaTreeNodes { get; set; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<MetaTreeNode>

OlapDataManager

Gets or sets the OLAP data manager.

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

PivotEngine

Gets or sets the pivot engine.

Declaration
public PivotEngine PivotEngine { get; set; }
Property Value
Type Description
PivotEngine

Methods

add_PageRefreshCompleted(RefreshCompletedEventHandler)

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

add_PageRefreshStarted(RefreshStartedEventHandler)

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

Dispose()

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

Declaration
public void Dispose()

GetChildNodes(MetaTreeNode, MetaTreeNodeCollection)

Gets the collection of child nodes for the specified node.

Declaration
public static MetaTreeNodeCollection GetChildNodes(MetaTreeNode parentNode, MetaTreeNodeCollection childNodeCollection)
Parameters
Type Name Description
MetaTreeNode parentNode

The node, for which the child nodes are identified.
MetaTreeNodeCollection childNodeCollection

The collection of all child nodes present under specified node.
Returns
Type Description
MetaTreeNodeCollection

GetReportMemberElements(MemberElement, MemberElementCollection)

Gets the collection of child member elements for the specified member element.

Declaration
public MemberElementCollection GetReportMemberElements(MemberElement parentMemberElement, MemberElementCollection childMemberElementCollection)
Parameters
Type Name Description
MemberElement parentMemberElement

The member element, for which the child member elements are identified.
MemberElementCollection childMemberElementCollection

The collection of child member elements for the member element.
Returns
Type Description
MemberElementCollection

The collection of all child member elements present under specified member element.

OnApplyTemplate()

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

Declaration
protected override void OnApplyTemplate()

RaisePageRefreshCompleted(RefreshEventArgs)

Raises the PageRefreshCompleted event.

Declaration
public void RaisePageRefreshCompleted(RefreshEventArgs e)
Parameters
Type Name Description
RefreshEventArgs e

The data for the event

RaisePageRefreshStarted(RefreshEventArgs)

Raises the Syncfusion.UI.Xaml.PivotClient.FilterEditor.PageRefreshStarted event.

Declaration
public void RaisePageRefreshStarted(RefreshEventArgs e)
Parameters
Type Name Description
RefreshEventArgs e

The data for the event.

remove_PageRefreshCompleted(RefreshCompletedEventHandler)

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

remove_PageRefreshStarted(RefreshStartedEventHandler)

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

Events

PageRefreshCompleted

Occurs when new page is loaded.

Declaration
public event RefreshCompletedEventHandler PageRefreshCompleted
Event Type
Type Description
RefreshCompletedEventHandler

PageRefreshStarted

Occurs when new page is started to loading.

Declaration
public event RefreshStartedEventHandler PageRefreshStarted
Event Type
Type Description
RefreshStartedEventHandler

Extension Methods