Share via


PivotFilter class

Defines the PivotFilter Class.This class is only available in O15. When the object is serialized out as xml, its qualified name is x15:pivotFilter.

Inheritance hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Office15.Excel.PivotFilter

Namespace:  DocumentFormat.OpenXml.Office15.Excel
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office15)> _
Public Class PivotFilter _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As PivotFilter
[OfficeAvailabilityAttribute(FileFormatVersions.Office15)]
public class PivotFilter : OpenXmlLeafElement

Remarks

2.4.50 pivotFilter

Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/11/main

A CT_PivotFilter element that specifies the extended properties of a filter (PivotTable Advanced Filter), as specified in ([ISO/IEC-29500-1] section 18.10.1.33). See section 2.2.4.4 for how this element integrates with the Office Open XML file formats specified in [ISO/IEC-29500-1].

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="pivotFilter" type="CT_PivotFilter"/>

See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.6.103 CT_PivotFilter

Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/11/main

Referenced by: pivotFilter

A complex type that specifies the extended properties of a CT_PivotFilter ([ISO/IEC-29500-4] section A.2) element.

Attributes:

useWholeDay: A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the filter ([ISO/IEC-29500-1] section 18.10.1.33) element extended by this type uses whole days in its filtering criteria. MUST be false for filters for which the value of the attribute type ([ISO/IEC-29500-1] section 18.10.1.33) is not one of the following.

Enumeration Value

dateBetween (Date Between)

dateEqual (Date Equals)

dateNewerThan (Date Newer Than)

dateNewerThanOrEqual (Date Newer Than or Equal To)

dateNotBetween (Date Not Between)

dateNotEqual (Date Does Not Equal)

dateOlderThan (Date Older Than)

dateOlderThanOrEqual (Date Older Than Or Equal)

lastMonth (Last Month)

lastQuarter (Last Quarter)

lastWeek (Last Week)

lastYear (Last Year)

M1 (January)

M10 (Dates in October)

M11 (Dates in November)

M12 (Dates in December)

M2 (Dates in February)

M3 (Dates in March)

M4 (Dates in April)

M5 (Dates in May)

M6 (Dates in June)

M7 (Dates in July)

M8 (Dates in August)

M9 (Dates in September)

nextMonth (Next Month)

nextQuarter (Next Quarter)

nextWeek (Next Week)

nextYear (Next Year)

percent (Percent)

Q1 (First Quarter)

Q2 (Second Quarter)

Q3 (Third Quarter)

Q4 (Fourth Quarter)

sum (Sum)

thisMonth (This Month)

thisQuarter (This Quarter)

thisWeek (This Week)

thisYear (This Year)

today (Today)

tomorrow (Tomorrow)

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_PivotFilter">

<xsd:attribute name="useWholeDay" type="xsd:boolean" use="optional" default="false"/>

</xsd:complexType>

See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

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.

See also

Reference

PivotFilter members

DocumentFormat.OpenXml.Office15.Excel namespace