DataValidationCollection.Add(CellRange, DataValidationType, ValueObject) Method

Creates a new data validation entry and adds it to the document’s collection.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v20.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

NuGet Packages: DevExpress.Spreadsheet.Core, DevExpress.WindowsDesktop.Spreadsheet.Core

Declaration

C#

DataValidation Add(
    CellRange range,
    DataValidationType validationType,
    ValueObject criteria
)

VB.NET

Function Add(
    range As CellRange,
    validationType As DataValidationType,
    criteria As ValueObject
) As DataValidation

Parameters

Name	Type	Description
range	CellRange	A CellRange object that is the worksheet range to which the data validation rule is applied.
validationType	DataValidationType	A DataValidationType enumeration member that specifies the validation type.
criteria	ValueObject	A ValueObject that is the value used in the criterion.

Returns

Type	Description
DataValidation	A DataValidation object that specifies a validation rule for a worksheet range.

Remarks

This method overload is used for validation types DataValidationType.Custom and DataValidationType.List.

For the DataValidationType.Custom type, the criteria is a string which can be recognized as a worksheet formula. Therefore, it must begin with an equal sign and evaluate to either true or false.

Note

An individual worksheet cell can have only one data validation rule associated with it. If subsequent Add method calls affect the same cell, only the data validation rule created in the last call is applied.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(CellRange, DataValidationType, ValueObject) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-spreadsheetcontrol-api-part-3-t289419/CS/SpreadsheetControl_WPF_API_Part03/CodeExamples/DataValidationActions.cs#L98

// Restrict data entry to a 5-digit number
DataValidation validation = worksheet.DataValidations.Add(worksheet["B4:B11"], DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)");

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/CodeExamples/DataValidationActions.cs#L97

// Restrict data entry to a 5-digit number
DataValidation validation = worksheet.DataValidations.Add(worksheet["B4:B11"], DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)");

spreadsheet-document-api-examples-part3/CS/Spreadsheet_Document_Api_Part_3/CodeExamples/DataValidationActions.cs#L97

// Restrict data entry to a 5-digit number
DataValidation validation = worksheet.DataValidations.Add(worksheet["B4:B11"], DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)");

VB.NET

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/CodeExamples/DataValidationActions.vb#L81

' Restrict data entry to a 5-digit number
Dim validation As DevExpress.Spreadsheet.DataValidation = worksheet.DataValidations.Add(worksheet("B4:B11"), DevExpress.Spreadsheet.DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)")
' Show input message.

spreadsheet-document-api-examples-part3/VB/Spreadsheet_Document_Api_Part_3/CodeExamples/DataValidationActions.vb#L81

' Restrict data entry to a 5-digit number
Dim validation As DevExpress.Spreadsheet.DataValidation = worksheet.DataValidations.Add(worksheet("B4:B11"), DevExpress.Spreadsheet.DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)")
' Show input message.

wpf-spreadsheetcontrol-api-part-3-t289419/VB/SpreadsheetControl_WPF_API_Part03/CodeExamples/DataValidationActions.vb#L99

' Restrict data entry to a 5-digit number
Dim validation As DataValidation = worksheet.DataValidations.Add(worksheet("B4:B11"), DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)")