API Reference
Class
ExcelPivotFilterInfo
Describes a pivot filter found in an existing pivot table.
Inheritance
- Object
- ExcelPivotFilterInfo
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property ExcelPivotTableInfo.Filters
Accepted by parameters
- Constructor ExcelPivotTableInfo.ExcelPivotTableInfo
Constructors
public ExcelPivotFilterInfo(String fieldName, Nullable<PivotFilterValues> type, String value1, String value2, String dataFieldName, String name, String description, Nullable<Boolean> isTop = null, Nullable<Boolean> isPercent = null, String filterValue = null) #Creates pivot filter readback information.
Parameters
- fieldName System.String
- type System.Nullable{DocumentFormat.OpenXml.Spreadsheet.PivotFilterValues}
- value1 System.String
- value2 System.String
- dataFieldName System.String
- name System.String
- description System.String
- isTop System.Nullable{System.Boolean} = null
- isPercent System.Nullable{System.Boolean} = null
- filterValue System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public String FieldName { get; } #Gets the source field name being filtered.
public Nullable<PivotFilterValues> Type { get; } #Gets the Open XML pivot filter type.
public String Value1 { get; } #Gets the first filter value.
public String Value2 { get; } #Gets the second filter value for between-style filters.
public String DataFieldName { get; } #Gets the data field used by value filters.
public String Name { get; } #Gets the filter display name.
public String Description { get; } #Gets the filter description.
public Nullable<Boolean> IsTop { get; } #Gets whether a top/bottom filter keeps top values. False means bottom values.
public Nullable<Boolean> IsPercent { get; } #Gets whether a top/bottom filter uses a percentage threshold.
public String FilterValue { get; } #Gets the optional calculated top/bottom filter value threshold.