DynamicFilter Class

Dynamic Filter.When the object is serialized out as xml, its qualified name is x:dynamicFilter.

Inheritance Hierarchy


Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)


Public Class DynamicFilter _
    Inherits OpenXmlLeafElement
Dim instance As DynamicFilter
public class DynamicFilter : OpenXmlLeafElement


[ISO/IEC 29500-1 1st Edition] dynamicFilter (Dynamic Filter)

This collection specifies dynamic filter criteria. These criteria are considered dynamic because they can change, either with the data itself (e.g., "above average") or with the current system date (e.g., show values for "today"). For any cells whose values do not meet the specified criteria, the corresponding rows shall be hidden from view when the filter is applied.


<filterColumn colId="0">
<dynamicFilter type="today"/>

end example]

Parent Elements

filterColumn (§



maxValIso (Max ISO Value)

A maximum value for dynamic filter. maxValIso shall be required for today, yesterday, tomorrow, nextWeek, thisWeek, lastWeek, nextMonth, thisMonth, lastMonth, nextQuarter, thisQuarter, lastQuarter, nextYear, thisYear, lastYear, and yearToDate.

The above criteria are based on a value range; that is, if today's date is September 22nd, then the range for thisWeek is the values greater than or equal to September 17 and less than September 24. In the thisWeek range, the lower value is expressed valIso. The higher value is expressed using maxValIso.

These dynamic filters shall not require valIso or maxValIso:

Q1, Q2, Q3, Q4, M1, M2, M3, M4, M5, M6, M7, M8, M9, M10, M11 and M12.

The above criteria shall not specify the range using valIso and maxValIso because Q1 always starts from M1 to M3, and M1 is always January.

These types of dynamic filters shall use valIso and shall not use maxValIso:

  • aboveAverage and belowAverage

The possible values for this attribute are defined by the W3C XML Schema dateTime datatype.

type (Dynamic filter type)

Dynamic filter type, e.g., “today” or “nextWeek”.

The possible values for this attribute are defined by the ST_DynamicFilterType simple type (§18.18.26).

valIso (ISO Value)

A minimum value for dynamic filter. (See description of maxValIso to understand when valIso is required.)

The possible values for this attribute are defined by the W3C XML Schema dateTime datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_DynamicFilter) 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.

See Also


DynamicFilter Members

DocumentFormat.OpenXml.Spreadsheet Namespace