C1.PivotEngine.PivotFilter
PivotFilter Class
Represents a filter used to select values for a field.
Implements
Namespace: C1.PivotEngine
Assembly: C1.PivotEngine.dll
Syntax
public class PivotFilter : INotifyPropertyChangedConstructors
| Name | Description |
|---|---|
| PivotFilter(PivotField) | Initializes a new instance of a PivotFilter. |
Properties
| Name | Description |
|---|---|
| AndConditions | Gets or sets whether the filter conditions should be combined with an 'And' or with an 'Or' operator. |
| Condition1 | Gets the first filter condition. |
| Condition2 | Gets the second filter condition. |
| Field | Gets the field that this filter is acting on. |
| IsActive | Gets a value that indicates the filter is active. |
| IsCustomFilterActive | Gets a value that indicates the custom filter is active. |
| ShowValues | Gets or sets an array with the values that should be included in the output. |
| TopN | Specifies the number of elements with the highest (lowest) values to be included in the output. |
| TopNRule | Defines whether the filter returns top N or bottom N elements. |
| TopNValueField | Defines the value field to be used to calculate the top N elements. |
| Values | Gets or sets the list of values to be displayed in the value filter list editor. |
Methods
| Name | Description |
|---|---|
| Apply(object) | Applies the filter to a value. |
| Clear() | Clears the filter. |
| OnPropertyChanged(PropertyChangedEventArgs) | Raises the PropertyChanged event. |
| ReadXml(XmlReader) | Reads a filter from Xml. |
| WriteXml(XmlWriter) | Persist filter to Xml. |
Events
| Name | Description |
|---|---|
| PropertyChanged | Fires when a property changes. |
Operators
| Name | Description |
|---|---|
| implicit operator C1FlexPivotFilter(PivotFilter) |