DataValidation Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the DataValidation Class.

This class is available in Office 2010 and above.

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

public class DataValidation : DocumentFormat.OpenXml.OpenXmlCompositeElement

type DataValidation = class
    inherit OpenXmlCompositeElement

Public Class DataValidation
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

DataValidation

Remarks

2.6.5 CT_DataValidation

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: CT_DataValidations

CT_DataValidation is a complex type that specifies data validation for a range on this sheet.

Child Elements:

formula1: A CT_DataValidationFormula element (section 2.6.4) that specifies the first formula for the data validation.

If operator is "between" or "notBetween" and type is not "custom", "list", or "none", this formula is used as the lesser of two bounding values and MUST exist.

If operator is not "between" or "notBetween", or type is "custom", this formula is the only formula and MUST exist.

If operator is not "between" or "notBetween", or type is "custom" or "list", either formula is the only formula and MUST exist or CT_DataValidation MUST have a list (section 2.4.42*) child element.*

If the type is "none", this formula MUST NOT exist.

formula2: A CT_DataValidationFormula element that specifies the second formula for the data validation.

If operator is "between" or "notBetween" and type is not "custom", "list", or "none", this formula is used as the greater of two bounding values and MUST exist.

If operator is not "between" or "notBetween", or type is "custom", "list", or "none", this formula MUST NOT exist.

xm:sqref: A sqref element (section 2.4.5) that specifies ranges to which data validation is applied.

Attributes:

type: An ST_DataValidationType ([ISO/IEC-29500-1] section 18.18.21) attribute that specifies the type of data validation.

errorStyle: An ST_DataValidationErrorStyle ([ISO/IEC-29500-1] section 18.18.18) attribute that specifies the style of error alert used for this data validation.

imeMode: An ST_DataValidationImeMode ([ISO/IEC-29500-1] section 18.18.19) attribute that specifies the Input Method Editor (IME) mode enforced by this data validation.

operator: An ST_DataValidationOperator ([ISO/IEC-29500-1] section 18.18.20) attribute that specifies the relational operator used with this data validation. If type is "custom", "list", or "none", the value of the operator attribute is undefined and MUST be ignored.

allowBlank: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data validation treats empty or blank entries as valid.

showDropDown: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether to display the drop-down combo box for a list type data validation.

Value of showDropDown	Value of type	Meaning
"true"	list	Displays the drop-down combo box.
"false"	list	Suppresses the drop-down combo box.

showInputMessage: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether to display the input prompt message.

showErrorMessage: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether to display the error alert message.

errorTitle: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the text of the title bar of the error alert. The length of this string MUST be less than or equal to 32 characters.

error: An ST_Xstring attribute that specifies the message text of the error alert. The length of this string MUST be less than or equal to 225 characters.

promptTitle: An ST_Xstring attribute that specifies the text of the title bar of the input prompt. The length of this string MUST be less than or equal to 32 characters.

prompt: An ST_Xstring attribute that specifies the message text of the input prompt. This string MUST be less than or equal to 255 characters.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_DataValidation">

<xsd:sequence>

<xsd:element name="formula1" type="CT_DataValidationFormula" minOccurs="0" maxOccurs="1"/>

<xsd:element name="formula2" type="CT_DataValidationFormula" minOccurs="0" maxOccurs="1"/>

<xsd:element ref="xm:sqref" minOccurs="1" maxOccurs="1"/>

</xsd:sequence>

<xsd:attribute name="type" type="x:ST_DataValidationType" use="optional" default="none"/>

<xsd:attribute name="errorStyle" type="x:ST_DataValidationErrorStyle" use="optional" default="stop"/>

<xsd:attribute name="imeMode" type="x:ST_DataValidationImeMode" use="optional" default="noControl"/>

<xsd:attribute name="operator" type="x:ST_DataValidationOperator" use="optional" default="between"/>

<xsd:attribute name="allowBlank" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="showDropDown" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="showInputMessage" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="showErrorMessage" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="errorTitle" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="error" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="promptTitle" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="prompt" type="x:ST_Xstring" use="optional"/>

</xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

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

Properties

AllowBlank	allowBlank, this property is only available in Office 2010 and later. Represents the following attribute in the schema: allowBlank
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DataValidationForumla1	DataValidationForumla1. Represents the following element tag in the schema: x14:formula1.
DataValidationForumla2	DataValidationForumla2. Represents the following element tag in the schema: x14:formula2.
Error	error, this property is only available in Office 2010 and later. Represents the following attribute in the schema: error
ErrorStyle	errorStyle, this property is only available in Office 2010 and later. Represents the following attribute in the schema: errorStyle
ErrorTitle	errorTitle, this property is only available in Office 2010 and later. Represents the following attribute in the schema: errorTitle
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)
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)
ImeMode	imeMode, this property is only available in Office 2010 and later. Represents the following attribute in the schema: imeMode
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, this property is only available in Office 2010 and later. 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)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Prompt	prompt, this property is only available in Office 2010 and later. Represents the following attribute in the schema: prompt
PromptTitle	promptTitle, this property is only available in Office 2010 and later. Represents the following attribute in the schema: promptTitle
ReferenceSequence	ReferenceSequence. Represents the following element tag in the schema: xne:sqref.
ShowDropDown	showDropDown, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showDropDown
ShowErrorMessage	showErrorMessage, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showErrorMessage
ShowInputMessage	showInputMessage, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showInputMessage
Type	type, this property is only available in Office 2010 and later. 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)