ConditionalFormatStyle Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the ConditionalFormatStyle Class.

This class is available in Office 2007 and above.

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

public class ConditionalFormatStyle : DocumentFormat.OpenXml.OpenXmlLeafElement

type ConditionalFormatStyle = class
    inherit OpenXmlLeafElement

Public Class ConditionalFormatStyle
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

ConditionalFormatStyle

Remarks

[ISO/IEC 29500-1 1st Edition]

cnfStyle (Paragraph Conditional Formatting)

This element specifies the set of conditional table style formatting properties which have been applied to this paragraph, if this paragraph is contained within a table cell. [Note: This property is an optimization which can be used by consumers to determine if a given property on a paragraph is the result of the table style properties vs. direct formatting on the paragraph itself. end note]

If this property is specified on a paragraph which is not contained within a table cell, then its contents shall be ignored when reading the contents of the document.

[Example: Consider a paragraph in the top right corner of a table with a table style applied and where the table is formatted as left to right. This paragraph would need to specify the following WordprocessingML:

<w:p>  
  <w:pPr>  
    <w:cnfStyle w:firstRow="true" w:lastColumn="true" w:firstRowLastColumn="true" />  
    …  
  </w:pPr>  
  …  
</w:p>  

This paragraph specifies that it has the conditional properties from the table style for the first column, first row, and the top right corner of the parent table by setting the appropriate attributes. end example]

Parent Elements
pPr (§17.3.1.26); pPr (§17.3.1.25); pPr (§17.7.5.2); pPr (§17.7.6.1); pPr (§17.9.23); pPr (§17.7.8.2)

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

[ISO/IEC 29500-1 1st Edition]

cnfStyle (Table Row Conditional Formatting)

This element specifies the set of conditional table style formatting properties which have been applied to this table row. [Note: This property is an optimization which is used by consumers to determine if a given property on a table row is the result of the table style conditional formatting properties vs. direct formatting on the table cell itself. It specifies the components of the conditional formatting in the table style applied to this cell, so that the table's conditional formatting can be applied after the document is displayed without having the table style properties override the style hierarchy. end note]

If this element is omitted, then its value shall be assumed to be zero for all entries in the bit mask.

[Example: Consider a table row in the top of a table with a table style applied. This table cell would need to specify the following WordprocessingML to express that fact:

<w:tr>  
  <w:trPr>  
    <w:cnfStyle w:firstRow="true" />  
    …  
  </w:trPr>  
  …  
</w:tr>  

This table row specifies that it has the conditional properties from the table style for the first row of the parent table by setting the appropriate attribute value. end example]

Parent Elements
trPr (§17.4.82); trPr (§17.7.6.10); trPr (§17.7.6.11); trPr (§17.4.83)

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

[ISO/IEC 29500-1 1st Edition]

cnfStyle (Table Cell Conditional Formatting)

This element specifies the set of conditional table style formatting properties which have been applied to this table cell. [Note: This property is an optimization which is used by consumers to determine if a given property on a table cell is the result of the table style conditional formatting properties vs. direct formatting on the table cell itself. It specifies the components of the conditional formatting in the table style applied to this cell, so that the table's conditional formatting can be applied after the document is displayed without having the table style properties override the style hierarchy. end note]

If this element is omitted, then its value shall be assumed to be zero for all entries in the bit mask.

[Example: Consider a table cell in the top right corner of a table with a table style applied and where the table is formatted as left to right. This table cell would need to specify the following WordprocessingML to express that fact:

<w:tc>  
  <w:tcPr>  
    <w:cnfStyle w:firstRow="true" w:lastColumn="true" w:firstRowLastColumn="true" />  
    …  
  </w:tcPr>  
  …  
</w:tc>  

This table cell specifies that it has the conditional properties from the table style for the first column, first row, and the top right corner of the parent table by setting the appropriate attributes. end example]

Parent Elements
tcPr (§17.7.6.8); tcPr (§17.7.6.9); tcPr (§17.4.70); tcPr (§17.4.71)

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

� ISO/IEC29500: 2008.

Constructors

ConditionalFormatStyle()

Initializes a new instance of the ConditionalFormatStyle class.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
EvenHorizontalBand	evenHBand, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:evenHBand
EvenVerticalBand	evenVBand, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:evenVBand
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 OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
FirstColumn	firstColumn, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:firstColumn
FirstRow	firstRow, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:firstRow
FirstRowFirstColumn	firstRowFirstColumn, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:firstRowFirstColumn
FirstRowLastColumn	firstRowLastColumn, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:firstRowLastColumn
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 OpenXmlLeafElement)
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LastColumn	lastColumn, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:lastColumn
LastRow	lastRow, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:lastRow
LastRowFirstColumn	lastRowFirstColumn, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:lastRowFirstColumn
LastRowLastColumn	lastRowLastColumn, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:lastRowLastColumn
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)
OddHorizontalBand	oddHBand, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:oddHBand
OddVerticalBand	oddVBand, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w:oddVBand
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
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)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Val	Conditional Formatting Bit Mask Represents the following attribute in the schema: w:val
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)
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 OpenXmlElement)
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 OpenXmlElement)
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 in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
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 elements. (Inherited from OpenXmlElement)
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 child elements of the current element. (Inherited from OpenXmlLeafElement)
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 from the current element's list of child elements. (Inherited from OpenXmlElement)
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 a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
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)