MetadataType Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Metadata Type Information.

This class is available in Office 2007 and above.

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

public class MetadataType : DocumentFormat.OpenXml.OpenXmlLeafElement

type MetadataType = class
    inherit OpenXmlLeafElement

Public Class MetadataType
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

MetadataType

Remarks

[ISO/IEC 29500-1 1st Edition]

metadataType (Metadata Type Information)

This element represents information about metadata on cells - it defines a specific set of behaviors that the metadata shall adhere to when subject to other spreadsheet operations.

In general, many of these attributes represent operations that can be performed on a cell that allow the metadata to remain associated with the cell. Operations that are set to 0 or false, will cause the metadata to be disassociated from the cell when that operation is performed.

Parent Elements
metadataTypes (§18.9.11)

Attributes	Description
adjust (Adjust Metadata)	A Boolean flag indicating that metadata corresponding to a particular cell needs to be notified when that cell's location is changed. [Note: This is included in the file format for future extensibility.end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
assign (Metadata Formula Assignment)	A Boolean flag indicating whether metadata is propagated by formula assignment operation. True when metadata should be propagated by assignment, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
cellMeta (Cell Metadata)	A Boolean flag indicating whether metadata is cell metadata. True when the metadata is cell metadata, false otherwise - in the false case it is considered to be value metadata. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
clearAll (Metadata Clear All)	A Boolean flag indicating whether metadata survives a "Clear: All" operation. True if the metadata persists after a clear all, false otherwise. The Clear operations can be implemented by the run time application to provide an easy way to allow users to delete everything from a cell (Clear: All), remove only comments (Clear: Comments), only remove formats (Clear: Formats), or only remove the contents but leave the comments and formatting (Clear: Contents). Note these operations can also be performed by the user manually deleting each item. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
clearComments (Metadata Clear Comments)	A Boolean flag indicating whether metadata remains after comments have been cleared from the cell. True if the metadata persists after Clear:Comments, false otherwise. The Clear operations can be implemented by the run time application to provide an easy way to allow users to delete everything from a cell (Clear: All), remove only comments (Clear: Comments), only remove formats (Clear: Formats), or only remove the contents but leave the comments and formatting (Clear: Contents). Note these operations can also be performed by the user manually deleting each item. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
clearContents (Metadata Clear Contents)	A Boolean flag indicating whether metadata remains after the contents of a cell are removed. True if metadata persists after a "Clear: Contents" action, false otherwise. The Clear operations can be implemented by the run time application to provide an easy way to allow users to delete everything from a cell (Clear: All), remove only comments (Clear: Comments), only remove formats (Clear: Formats), or only remove the contents but leave the comments and formatting (Clear: Contents). Note these operations can also be performed by the user manually deleting each item. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
clearFormats (Metadata Clear Formats)	A Boolean flag indicating whether metadata remains after formatting is removed from a cell. True if metadata persists after a "Clear: Formats", false otherwise. The Clear operations can be implemented by the run time application to provide an easy way to allow users to delete everything from a cell (Clear: All), remove only comments (Clear: Comments), only remove formats (Clear: Formats), or only remove the contents but leave the comments and formatting (Clear: Contents). Note these operations can also be performed by the user manually deleting each item. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
coerce (Metadata Coercion)	A Boolean flag indicating whether value metadata can be removed when this metadata data type is coerced to another data type. True if the value metadata is removed upon coercion, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
copy (Metadata Copy)	A Boolean flag indicating whether metadata is copied with a cell. True if the metadata is copied to other cells when this cell is copied, false otherwise. This shall be set to true if the paste attributes for the metadataType are going to be used. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
delete (Metadata Cell Value Delete)	A Boolean flag indicating whether metadata survives deletion of a cell value. True when the metadata persists after the deletion of a cell value, false otherwise. This attribute is equivalent to the clearContents attribute. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
edit (Metadata Edit)	A Boolean flag indicating whether metadata survives the editing of the cell's value. True if the metadata remains unchanged after the cell's value edit, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
ghostCol (Metadata Ghost Column)	A Boolean flag indicating whether metadata is copied to/from a ghost column. True when the metadata is copied to/from a ghost column, false otherwise. A ghost column is a single column that exists for the row header. It is not displayed to the end user. It is used to store default formatting for an entire row (i.e. the row gets the formatting for the corresponding cell in the ghost column). For instance, when an entire row is selected and a cell color is applied, this is stored once for the cell in the ghost column instead of for each cell in the row. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
ghostRow (Metadata Ghost Row)	A Boolean flag indicating whether metadata is copied to/from a ghost row. True when the metadata is copied to/from a ghost row, false otherwise. A ghost row is a single row that exists for the column header. It is not displayed to the end user. It is used to store default formatting for an entire column (i.e. the column gets the formatting for the corresponding cell in the ghost row). For instance, when an entire column is selected and a cell color is applied, this is stored once for the cell in the ghost row instead of for each cell in the column. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
merge (Metadata Merge)	A Boolean flag indicating whether metadata survives cell merge. True if the metadata persists after a cell merge, false otherwise. It is up to the spreadsheet application on how to deal with conflicts when two cells that each have metadata are merged. The guidance here is to treat it the same as a 'regular' cell merge with the default behavior being that the data in the upper left cell wins. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
minSupportedVersion (Minimum Supported Version)	The earliest version of the spreadsheet application that supports this metadata type. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
name (Metadata Type Name)	Represents the name of this particular metadata type. This name shall be unique amongst all other metadataTypes. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
pasteAll (Metadata Paste All)	A Boolean flag indicating whether metadata is populated to a new cell by "Paste: All". True when the metadata is populated on a Paste:All, false otherwise. Paste:All and regular paste should be implemented so that they are equivalent by the spreadsheet application. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteBorders (Metadata Paste Borders)	A Boolean flag indicating whether metadata is populated with Paste: Borders. True when the metadata is populated when only borders are pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: The spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteColWidths (Metadata Paste Column Widths)	A Boolean flag indicating whether metadata is populated by Paste: Column Widths. True if the metadata is populated when only column widths are pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteComments (Metadata Paste Comments)	A Boolean flag indicating whether metadata is populated by Paste: Comments. True when metadata is populated when only comments are pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteDataValidation (Metadata Paste Data Validation)	A Boolean flag indicating whether metadata is populated by Paste: Validation. True when metadata is populated when only data validation is pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteFormats (Metadata Paste Formats)	A Boolean flag indicating whether metadata is populated by Paste Special: Formats. True when metadata is populated when only formatting is pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteFormulas (Metadata Paste Formulas)	A Boolean flag indicating whether metadata is populated by Paste: Formulas. True when the metadata is populated when only formulas are pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteNumberFormats (Metadata Paste Number Formats)	A Boolean flag indicating whether metadata is populated with Paste: Number Formats. True when metadata is populated when only number formatting is pasted, false otherwise. The copy flag shall be set to true for this paste behavior to be respected. [Note: the spreadsheet application can implement special pasting behavior, such as pasting everything from a cell (paste all/normal paste), pasting only borders, pasting only comments, or pasting only any other specific cell property. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
pasteValues (Metadata Paste Special Values)	A Boolean flag indicating whether metadata is populated by Paste: Values. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
rowColShift (Metadata Insert Delete)	A Boolean flag indicating whether metadata survives shifting due to row/column insertion/deletion. True if the metadata persists after the cell has been shifted, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
splitAll (Metadata Split All)	A Boolean flag indicating whether a merged cell split action has its metadata copied to all of the resulting cells. True if the metadata is copied to all new cells resulting from a split, false otherwise. If splitFirst is also set to true, splitAll wins - that is all the cells shall have the metadata copied to them. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
splitFirst (Meatadata Split First)	A Boolean flag indicating whether when a merged cell is split its metadata is copied to only the first resulting cell. True when the metadata from a split cell is only copied to the first resulting cell, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

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

� ISO/IEC29500: 2008.

Constructors

MetadataType()

Initializes a new instance of the MetadataType class.

Properties

Adjust	Adjust Metadata Represents the following attribute in the schema: adjust
Assign	Metadata Formula Assignment Represents the following attribute in the schema: assign
CellMeta	Cell Metadata Represents the following attribute in the schema: cellMeta
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ClearAll	Metadata Clear All Represents the following attribute in the schema: clearAll
ClearComments	Metadata Clear Comments Represents the following attribute in the schema: clearComments
ClearContents	Metadata Clear Contents Represents the following attribute in the schema: clearContents
ClearFormats	Metadata Clear Formats Represents the following attribute in the schema: clearFormats
Coerce	Metadata Coercion Represents the following attribute in the schema: coerce
Copy	Metadata Copy Represents the following attribute in the schema: copy
Delete	Metadata Cell Value Delete Represents the following attribute in the schema: delete
Edit	Metadata Edit Represents the following attribute in the schema: edit
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)
GhostColumn	Metadata Ghost Column Represents the following attribute in the schema: ghostCol
GhostRow	Metadata Ghost Row Represents the following attribute in the schema: ghostRow
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)
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)
Merge	Metadata Merge Represents the following attribute in the schema: merge
MinSupportedVersion	Minimum Supported Version Represents the following attribute in the schema: minSupportedVersion
Name	Metadata Type Name Represents the following attribute in the schema: name
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)
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)
PasteAll	Metadata Paste All Represents the following attribute in the schema: pasteAll
PasteBorders	Metadata Paste Borders Represents the following attribute in the schema: pasteBorders
PasteColWidths	Metadata Paste Column Widths Represents the following attribute in the schema: pasteColWidths
PasteComments	Metadata Paste Comments Represents the following attribute in the schema: pasteComments
PasteDataValidation	Metadata Paste Data Validation Represents the following attribute in the schema: pasteDataValidation
PasteFormats	Metadata Paste Formats Represents the following attribute in the schema: pasteFormats
PasteFormulas	Metadata Paste Formulas Represents the following attribute in the schema: pasteFormulas
PasteNumberFormats	Metadata Paste Number Formats Represents the following attribute in the schema: pasteNumberFormats
PasteValues	Metadata Paste Special Values Represents the following attribute in the schema: pasteValues
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RowColumnShift	Metadata Insert Delete Represents the following attribute in the schema: rowColShift
SplitAll	Metadata Split All Represents the following attribute in the schema: splitAll
SplitFirst	Meatadata Split First Represents the following attribute in the schema: splitFirst
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)