ConditionalFormattingRule Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Conditional Formatting Rule.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:cfRule.

public class ConditionalFormattingRule : DocumentFormat.OpenXml.OpenXmlCompositeElement

type ConditionalFormattingRule = class
    inherit OpenXmlCompositeElement

Public Class ConditionalFormattingRule
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

ConditionalFormattingRule

Remarks

[ISO/IEC 29500-1 1st Edition]

cfRule (Conditional Formatting Rule)

This collection represents a description of a conditional formatting rule.

[Example:

This example shows a conditional formatting rule highlighting cells whose values are greater than 0.5. Note that in this case the content of <formula> is a static value, but can also be a formula expression.

<conditionalFormatting sqref="E3:E9">  
  <cfRule type="cellIs" dxfId="0" priority="1" operator="greaterThan">  
    <formula>0.5</formula>  
  </cfRule>  
</conditionalFormatting>  

end example]

Only rules with a type attribute value of expression support formula syntax.

Parent Elements
conditionalFormatting (§18.3.1.18)

Child Elements	Subclause
colorScale (Color Scale)	§18.3.1.16
dataBar (Data Bar)	§18.3.1.28
extLst (Future Feature Data Storage Area)	§18.2.10
formula (Formula)	§18.3.1.43
iconSet (Icon Set)	§18.3.1.49

Attributes	Description
aboveAverage (Above Or Below Average)	Indicates whether the rule is an "above average" rule. '1' indicates 'above average'. This attribute is ignored if type is not equal to aboveAverage. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
bottom (Bottom N)	Indicates whether a "top/bottom n" rule is a "bottom n" rule. '1' indicates 'bottom'. This attribute is ignored if type is not equal to top10. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dxfId (Differential Formatting Id)	This is an index to a dxf element in the Styles Part indicating which cell formatting to apply when the conditional formatting rule criteria is met. The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
equalAverage (Equal Average)	Flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value. '1' indicates to include the average value in the criteria. This attribute is ignored if type is not equal to aboveAverage. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
operator (Operator)	The operator in a "cell value is" conditional formatting rule. This attribute is ignored if type is not equal to cellIs The possible values for this attribute are defined by the ST_ConditionalFormattingOperator simple type (§18.18.15).
percent (Top 10 Percent)	Indicates whether a "top/bottom n" rule is a "top/bottom n percent" rule. This attribute is ignored if type is not equal to top10. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
priority (Priority)	The priority of this conditional formatting rule. This value is used to determine which format should be evaluated and rendered. Lower numeric values are higher priority than higher numeric values, where '1' is the highest priority. The possible values for this attribute are defined by the W3C XML Schema int datatype.
rank (Rank)	The value of "n" in a "top/bottom n" conditional formatting rule. This attribute is ignored if type is not equal to top10. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
stdDev (StdDev)	The number of standard deviations to include above or below the average in the conditional formatting rule. This attribute is ignored if type is not equal to aboveAverage. If a value is present for stdDev and the rule type = aboveAverage, then this rule is automatically an "above or below N standard deviations" rule. The possible values for this attribute are defined by the W3C XML Schema int datatype.
stopIfTrue (Stop If True)	If this flag is '1', no rules with lower priority shall be applied over this rule, when this rule evaluates to true. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
text (Text)	The text value in a "text contains" conditional formatting rule. This attribute is ignored if type is not equal to containsText. The possible values for this attribute are defined by the W3C XML Schema string datatype.
timePeriod (Time Period)	The applicable time period in a "date occurring…" conditional formatting rule. This attribute is ignored if type is not equal to timePeriod. The possible values for this attribute are defined by the ST_TimePeriod simple type (§18.18.82).
type (Type)	Type of conditional formatting rule. The possible values for this attribute are defined by the ST_CfType simple type (§18.18.12).

[Note: The W3C XML Schema definition of this element’s content model (CT_CfRule) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

ConditionalFormattingRule()	Initializes a new instance of the ConditionalFormattingRule class.
ConditionalFormattingRule(IEnumerable<OpenXmlElement>)	Initializes a new instance of the ConditionalFormattingRule class with the specified child elements.
ConditionalFormattingRule(OpenXmlElement[])	Initializes a new instance of the ConditionalFormattingRule class with the specified child elements.
ConditionalFormattingRule(String)	Initializes a new instance of the ConditionalFormattingRule class from outer XML.

Properties

AboveAverage	Above Or Below Average Represents the following attribute in the schema: aboveAverage
Bottom	Bottom N Represents the following attribute in the schema: bottom
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
EqualAverage	Equal Average Represents the following attribute in the schema: equalAverage
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FormatId	Differential Formatting Id Represents the following attribute in the schema: dxfId
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
Operator	Operator Represents the following attribute in the schema: operator
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Percent	Top 10 Percent Represents the following attribute in the schema: percent
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Priority	Priority Represents the following attribute in the schema: priority
Rank	Rank Represents the following attribute in the schema: rank
StdDev	StdDev Represents the following attribute in the schema: stdDev
StopIfTrue	Stop If True Represents the following attribute in the schema: stopIfTrue
Text	Text Represents the following attribute in the schema: text
TimePeriod	Time Period Represents the following attribute in the schema: timePeriod
Type	Type Represents the following attribute in the schema: type
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)