2.2.5.1 AutoFilterCriteriaType

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

Specifies how data is to be filtered by the protocol server when using the AutoFilterOptions complex type (section 2.2.4.14).

Each enumeration value falls under one of three categories shown in the following table. The category that MUST be used is determined by the CT_item element, as specified in [MS-EXSPXML3] section 2.3.18.

Category

Meaning

Agnostic

Enumeration values falling under the Agnostic category can always be passed to the protocol server.

Numeric

Enumeration values falling under the Numeric category MUST be passed only for AutoFilters that have the DataType attribute of the CT_item element, as specified in [MS-EXSPXML3] section 2.3.18, either missing or containing the string "Number".

Calendar

Enumeration values falling under the Calendar category MUST be passed only for AutoFilters that have the DataType attribute of the CT_item element, as specified in [MS-EXSPXML3] section 2.3.18, containing the string "Date".

 

 <xs:simpleType name="AutoFilterCriteriaType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:restriction base="xs:string">
     <xs:enumeration value="Nil"/>
     <xs:enumeration value="AboveAverage"/>
     <xs:enumeration value="BelowAverage"/>
     <xs:enumeration value="Tomorrow"/>
     <xs:enumeration value="Today"/>
     <xs:enumeration value="Yesterday"/>
     <xs:enumeration value="NextWeek"/>
     <xs:enumeration value="ThisWeek"/>
     <xs:enumeration value="LastWeek"/>
     <xs:enumeration value="NextMonth"/>
     <xs:enumeration value="ThisMonth"/>
     <xs:enumeration value="LastMonth"/>
     <xs:enumeration value="NextQuarter"/>
     <xs:enumeration value="ThisQuarter"/>
     <xs:enumeration value="LastQuarter"/>
     <xs:enumeration value="NextYear"/>
     <xs:enumeration value="ThisYear"/>
     <xs:enumeration value="LastYear"/>
     <xs:enumeration value="YearToDate"/>
     <xs:enumeration value="Q1"/>
     <xs:enumeration value="Q2"/>
     <xs:enumeration value="Q3"/>
     <xs:enumeration value="Q4"/>
     <xs:enumeration value="M1"/>
     <xs:enumeration value="M2"/>
     <xs:enumeration value="M3"/>
     <xs:enumeration value="M4"/>
     <xs:enumeration value="M5"/>
     <xs:enumeration value="M6"/>
     <xs:enumeration value="M7"/>
     <xs:enumeration value="M8"/>
     <xs:enumeration value="M9"/>
     <xs:enumeration value="M10"/>
     <xs:enumeration value="M11"/>
     <xs:enumeration value="M12"/>
     <xs:enumeration value="LastCount"/>
   </xs:restriction>
 </xs:simpleType>

The following table specifies the allowable values for the AutoFilterCriteriaType simple type.

Value

Meaning

Nil

MUST be used when the Criteria element of the AutoFilterOptions is present. Otherwise, MUST NOT be present. Category: Agnostic.

AboveAverage

Filters all numeric values that are greater than the average of the numeric values being filtered. Category: Numeric.

BelowAverage

Filters all numeric values that are less than the average of the numeric values being filtered. Category: Numeric.

Tomorrow

Filters all date values that are set to tomorrow's date. Category: Calendar.

Today

Filters all date values that are set to today's date. Category: Calendar.

Yesterday

Filters all date values that are set to yesterday's date. Category: Calendar.

NextWeek

Filters all date values that fall within next week. Category: Calendar.

ThisWeek

Filters all date values that fall within this week. Category: Calendar.

LastWeek

Filters all date values that fall within last week. Category: Calendar.

NextMonth

Filters all date values that fall within next month. Category: Calendar.

ThisMonth

Filters all date values that fall within this month. Category: Calendar.

LastMonth

Filters all date values that fall within last month. Category: Calendar.

NextQuarter

Filters all date values that fall within the next quarter. Category: Calendar.

ThisQuarter

Filters all date values that fall within this quarter. Category: Calendar.

LastQuarter

Filters all date values that fall within the last quarter. Category: Calendar.

NextYear

Filters all date values that fall within next year. Category: Calendar.

ThisYear

Filters all date values that fall within this year. Category: Calendar.

LastYear

Filters all date values that fall within the last year. Category: Calendar.

YearToDate

Filters all date values that occurred between the beginning of the year and up to and including the current date. Category: Calendar.

Q1

Filters all date values that fall within the first quarter of a year. Category: Calendar.

Q2

Filters all date values that fall the second quarter of a year. Category: Calendar.

Q3

Filters all date values that fall within the third quarter of a year. Category: Calendar.

Q4

Filters all date values that fall within the fourth quarter of a year. Category: Calendar.

M1

Filters all date values that fall within the first month of a year. Category: Calendar.

M2

Filters all date values that fall within the second month of a year. Category: Calendar.

M3

Filters all date values that fall within the third month of a year. Category: Calendar.

M4

Filters all date values that fall within the fourth month of a year. Category: Calendar.

M5

Filters all date values that fall within the fifth month of a year. Category: Calendar.

M6

Filters all date values that fall within the sixth month of a year. Category: Calendar.

M7

Filters all date values that fall within the seventh month of a year. Category: Calendar.

M8

Filters all date values that fall within the eighth month of a year. Category: Calendar.

M9

Filters all date values that fall within the ninth month of a year. Category: Calendar.

M10

Filters all date values that fall within the tenth month of a year. Category: Calendar.

M11

Filters all date values that fall within the eleventh month of a year. Category: Calendar.

M12

Filters all date values that fall within the twelfth month of a year. Category: Calendar.

LastCount

MUST NOT be used.