DataValidation Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Data Validation.

This class is available in Office 2007 and above.

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

public class DataValidation : DocumentFormat.OpenXml.OpenXmlCompositeElement

type DataValidation = class
    inherit OpenXmlCompositeElement

Public Class DataValidation
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

DataValidation

Remarks

[ISO/IEC 29500-1 1st Edition]

dataValidation (Data Validation)

A single item of data validation defined on a range of the worksheet.

Parent Elements
dataValidations (§18.3.1.33)

Child Elements	Subclause
formula1 (Formula 1)	§18.3.1.44
formula2 (Formula 2)	§18.3.1.45

Attributes	Description
allowBlank (Allow Blank)	A boolean value indicating whether the data validation allows the use of empty or blank entries. '1' means empty entries are OK and do not violate the validation constraints. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
error (Error Message)	Message text of error alert. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
errorStyle (Data Validation Error Style)	The style of error alert used for this data validation. The possible values for this attribute are defined by the ST_DataValidationErrorStyle simple type (§18.18.18).
errorTitle (Error Alert Text)	Title bar text of error alert. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
imeMode (IME Mode Enforced)	The IME (input method editor) mode enforced by this data validation. Only applies for these languages: - Chinese Simplified - Chinese Traditional - Japanese - Korean - When imeMode is set, the input for the cell can be restricted to specific sets of characters, as specified by the value of imeMode. See the simple type referenced below for additional details. When imeMode is set but the application's language is not one of the languages listed above, then the default value is noControl. The possible values for this attribute are defined by the ST_DataValidationImeMode simple type (§18.18.19).
operator (Operator)	The relational operator used with this data validation. The possible values for this attribute are defined by the ST_DataValidationOperator simple type (§18.18.20).
prompt (Input Prompt)	Message text of input prompt. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
promptTitle (Prompt Title)	Title bar text of input prompt. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
showDropDown (Show Drop Down)	A boolean value indicating whether to display a dropdown combo box for a list type data validation. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showErrorMessage (Show Error Message)	A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showInputMessage (Show Input Message)	A boolean value indicating whether to display the input prompt message. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
sqref (Sequence of References)	Range over which data validation is applied. The possible values for this attribute are defined by the ST_Sqref simple type (§18.18.76).
type (Data Validation Type)	The type of data validation. The possible values for this attribute are defined by the ST_DataValidationType simple type (§18.18.21).

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

� ISO/IEC29500: 2008.

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 Represents the following attribute in the schema: allowBlank
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Error	error Represents the following attribute in the schema: error
ErrorStyle	errorStyle Represents the following attribute in the schema: errorStyle
ErrorTitle	errorTitle 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)
Formula1	Formula1. Represents the following element tag in the schema: x:formula1.
Formula2	Formula2. Represents the following element tag in the schema: x:formula2.
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 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)
List	List, this property is only available in Office 2013 and later.. Represents the following element tag in the schema: x12ac:list.
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)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Prompt	prompt Represents the following attribute in the schema: prompt
PromptTitle	promptTitle Represents the following attribute in the schema: promptTitle
SequenceOfReferences	sqref Represents the following attribute in the schema: sqref
ShowDropDown	showDropDown Represents the following attribute in the schema: showDropDown
ShowErrorMessage	showErrorMessage Represents the following attribute in the schema: showErrorMessage
ShowInputMessage	showInputMessage Represents the following attribute in the schema: showInputMessage
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)