CellFormat Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Formatting Elements.

This class is available in Office 2007 and above.

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

public class CellFormat : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CellFormat = class
    inherit OpenXmlCompositeElement

Public Class CellFormat
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

CellFormat

Remarks

[ISO/IEC 29500-1 1st Edition]

xf (Format)

A single xf element describes all of the formatting for a cell.

Parent Elements
cellStyleXfs (§18.8.9); cellXfs (§18.8.10)

Child Elements	Subclause
alignment (Alignment)	§18.8.1
extLst (Future Feature Data Storage Area)	§18.2.10
protection (Protection Properties)	§18.8.33

Attributes	Description
applyAlignment (Apply Alignment)	A boolean value indicating whether the alignment formatting specified for this xf should be applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyBorder (Apply Border)	A boolean value indicating whether the border formatting specified for this xf should be applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyFill (Apply Fill)	A boolean value indicating whether the fill formatting specified for this xf should be applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyFont (Apply Font)	A boolean value indicating whether the font formatting specified for this xf should be applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyNumberFormat (Apply Number Format)	A boolean value indicating whether the number formatting specified for this xf should be applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyProtection (Apply Protection)	A boolean value indicating whether the protection formatting specified for this xf should be applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
borderId (Border Id)	Zero-based index of the border record used by this cell format. The possible values for this attribute are defined by the ST_BorderId simple type (§18.18.2).
fillId (Fill Id)	Zero-based index of the fill record used by this cell format. The possible values for this attribute are defined by the ST_FillId simple type (§18.18.30).
fontId (Font Id)	Zero-based index of the font record used by this cell format. The possible values for this attribute are defined by the ST_FontId simple type (§18.18.32).
numFmtId (Number Format Id)	Id of the number format (numFmt) record used by this cell format. The possible values for this attribute are defined by the ST_NumFmtId simple type (§18.18.47).
pivotButton (Pivot Button)	A boolean value indicating whether the cell rendering includes a pivot table dropdown button. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
quotePrefix (Quote Prefix)	A boolean value indicating whether the text string in a cell should be prefixed by a single quote mark (e.g., 'text). In these cases, the quote is not stored in the Shared Strings Part. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
xfId (Format Id)	For xf records contained in cellXfs this is the zero-based index of an xf record contained in cellStyleXfs corresponding to the cell style applied to the cell. Not present for xf records contained in cellStyleXfs. The possible values for this attribute are defined by the ST_CellStyleXfId simple type (§18.18.10).

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

Alignment	Alignment. Represents the following element tag in the schema: x:alignment.
ApplyAlignment	Apply Alignment Represents the following attribute in the schema: applyAlignment
ApplyBorder	Apply Border Represents the following attribute in the schema: applyBorder
ApplyFill	Apply Fill Represents the following attribute in the schema: applyFill
ApplyFont	Apply Font Represents the following attribute in the schema: applyFont
ApplyNumberFormat	Apply Number Format Represents the following attribute in the schema: applyNumberFormat
ApplyProtection	Apply Protection Represents the following attribute in the schema: applyProtection
BorderId	Border Id Represents the following attribute in the schema: borderId
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
ExtensionList	Future Feature Data Storage Area. Represents the following element tag in the schema: x:extLst.
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)
FillId	Fill Id Represents the following attribute in the schema: fillId
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FontId	Font Id Represents the following attribute in the schema: fontId
FormatId	Format Id Represents the following attribute in the schema: xfId
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)
NumberFormatId	Number Format Id Represents the following attribute in the schema: numFmtId
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)
PivotButton	Pivot Button Represents the following attribute in the schema: pivotButton
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Protection	Protection. Represents the following element tag in the schema: x:protection.
QuotePrefix	Quote Prefix Represents the following attribute in the schema: quotePrefix
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)