PivotFilter Class
PivotTable Advanced Filter.When the object is serialized out as xml, its qualified name is x:filter.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Spreadsheet.PivotFilter
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList))> _
<ChildElementInfoAttribute(GetType(AutoFilter))> _
Public Class PivotFilter _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As PivotFilter
[ChildElementInfoAttribute(typeof(ExtensionList))]
[ChildElementInfoAttribute(typeof(AutoFilter))]
public class PivotFilter : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
AutoFilter <x:autoFilter>
ExtensionList <x:extLst>
[ISO/IEC 29500-1 1st Edition]
18.10.1.33 filter (PivotTable Advanced Filter)
Represents a PivotTable advanced filter.
[Example:
<sh:filter fld="3" type="count" id="1" iMeasureHier="187">
<sh:autoFilter ref="A1">
<sh:filterColumn colId="0">
<sh:top10 val="5"/>
</sh:filterColumn>
</sh:autoFilter>
</sh:filter>
end example]
Parent Elements |
|---|
filters (§18.10.1.34) |
Child Elements |
Subclause |
|---|---|
autoFilter (AutoFilter Settings) |
§18.3.1.2 |
extLst (Future Feature Data Storage Area) |
§18.2.10 |
Attributes |
Description |
|---|---|
description (Pivot Filter Description) |
Specifies the description of the pivot filter. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
evalOrder (Evaluation Order) |
Specifies the evaluation order of the pivot filter. This attribute is zero-based. The possible values for this attribute are defined by the W3C XML Schema int datatype. |
fld (Field Index) |
Specifies the index of the field to which this pivot filter belongs. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
id (Pivot Filter Id) |
Specifies the unique identifier of the pivot filter as assigned by the PivotTable. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
iMeasureFld (Measure Field Index) |
Specifies the index of the measure field. This attribute is used only by filters in Relational pivots and specifies on which measure a value filter should apply. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
iMeasureHier (Measure Index) |
Specifies the index of the measure cube field. This attribute is used only by filters in OLAP pivots and specifies on which measure a value filter should apply. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
mpFld (Member Property Field Id) |
Specifies the index of the field representing the member property field on which this pivot filter is defined. This attribute is used only by label pivot filters. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
name (Pivot Filter Name) |
Specifies the name of the pivot filter. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
stringValue1 (Label Pivot) |
Specifies the string value "1" used by label pivot filters. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
stringValue2 (Label Pivot Filter String Value 2) |
Specifies the string value "2" used by label pivot filters. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
type (Pivot Filter Type) |
Specifies the type of the pivot filter. The possible values for this attribute are defined by the ST_PivotFilterType simple type (§18.18.59). |
[Note: The W3C XML Schema definition of this element’s content model (CT_PivotFilter) is located in §A.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.