Class FilterItemsCollection

Class that holds the collection of objects that are filtered.

Inheritance
System.Object
FilterItemsCollection
Namespace: Syncfusion.PivotAnalysis.UWP
Assembly: Syncfusion.PivotAnalysis.UWP.dll
Syntax
public class FilterItemsCollection : List<FilterItemElement>

Constructors

FilterItemsCollection()

Initializes a new instance of the FilterItemsCollection class.

Declaration
public FilterItemsCollection()

Properties

AllFilterItem

Gets or sets the property with all the filter items.

Declaration
public FilterItemElement AllFilterItem { get; set; }
Property Value
Type
FilterItemElement

AllowRunTimeGroupByField

Gets or sets the value to enable/disable grouping for the filter item. Default value is true.

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

Comparer

Gets or sets the comparer of all PivotFields in the Pivot control.

Declaration
public IComparer Comparer { get; set; }
Property Value
Type
System.Collections.IComparer

DisplayHeader

Gets or sets the header value for the PivotItem.

Declaration
public string DisplayHeader { get; set; }
Property Value
Type
System.String

EnableAllFilterItem

Gets or sets the value indicating whether to display the "(All)" filter in the collection or not.

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

FieldCaption

Gets or sets the caption value for the PivotItem.

Declaration
public string FieldCaption { get; set; }
Property Value
Type
System.String

FilteredValues

Gets or sets the filtered values.

Declaration
public List<string> FilteredValues { get; set; }
Property Value
Type
System.Collections.Generic.List<System.String>

FilterProperty

Gets or sets the filter property.

Declaration
public PropertyInfo FilterProperty { get; set; }
Property Value
Type
System.Reflection.PropertyInfo

Format

Gets or sets the format for the PivotItem.

Declaration
public string Format { get; set; }
Property Value
Type
System.String

Name

Gets or sets the content for the name property.

Declaration
public string Name { get; set; }
Property Value
Type
System.String

ShowSubTotal

Gets or sets the value that indicating whether the subtotals are visible or not.

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

Methods

AcceptChanges()

Accept the changes in the filter items collection.

Declaration
public void AcceptChanges()

AddIfUnique(FilterItemElement)

Returns the respective location to add the filter item.

Declaration
public int AddIfUnique(FilterItemElement filterItemElement)
Parameters
Type Name Description
FilterItemElement filterItemElement

Filter item.
Returns
Type Description
System.Int32

Location to add the filter item.

AddWireEvent(FilterItemElement)

Add filter item in the collection.

Declaration
public void AddWireEvent(FilterItemElement element)
Parameters
Type Name Description
FilterItemElement element

Filter item.

GetFilterExpression(Boolean)

To get the filter expression from IEnumerable source.

Declaration
public string GetFilterExpression(bool IEnumerableSource)
Parameters
Type Name Description
System.Boolean IEnumerableSource

Indicates whether the ItemSourece is IList or DataTable.
Returns
Type
System.String

GetFilterExpression(Boolean, FilterItemsCollection, String)

Returns the filter expression for the filter items collection from IEnumerable source.

Declaration
public string GetFilterExpression(bool IEnumerableSource, FilterItemsCollection filterItemsCollection, string format)
Parameters
Type Name Description
System.Boolean IEnumerableSource

Indicates whether the ItemSource is IList or DataTable.
FilterItemsCollection filterItemsCollection

Collection of filtered items.
System.String format

Format of the filtered item.
Returns
Type
System.String

GetFilterExpressionForDataView()

To get the filter expression for DataView source.

Declaration
public string GetFilterExpressionForDataView()
Returns
Type Description
System.String

Filter expression.

GetFilterItem()

Returns key of the filter item, if the filter items are selected else returns empty string.

Declaration
public string GetFilterItem()
Returns
Type
System.String

RejectChanges()

Rejects the changes in filter items collection.

Declaration
public void RejectChanges()

SetName(String)

Method used to set the name of the filter item.

Declaration
public void SetName(string name)
Parameters
Type Name Description
System.String name

Name of the filter item.

Extension Methods