ColorFilter Class

Color Filter Criteria.When the object is serialized out as xml, its qualified name is x:colorFilter.

Inheritance Hierarchy


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


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


[ISO/IEC 29500-1 1st Edition] colorFilter (Color Filter Criteria)

This element specifies the color to filter by and whether to use the cell's fill or font color in the filter criteria. If the cell's font or fill color does not match the color specified in the criteria, the rows corresponding to those cells are hidden from view.


<filterColumn colId="1">
<colorFilter dxfId="0" cellColor="0"/>

end example]

Parent Elements

filterColumn (§



cellColor (Filter By Cell Color)

Flag indicating whether or not to filter by the cell's fill color. '1' indicates to filter by cell fill. '0' indicates to filter by the cell's font color.

For rich text in cells, if the color specified appears in the cell at all, it shall be included in the filter.

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

dxfId (Differential Format Record Id)

Id of differential format record (dxf) in the Styles Part which expresses the color value to filter by.

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

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


ColorFilter Members

DocumentFormat.OpenXml.Spreadsheet Namespace