Back to Devexpress

DataValidation.Criteria Property

officefileapi-devexpress-dot-spreadsheet-dot-datavalidation-053ef98b.md

latest7.1 KB
Original Source

DataValidation.Criteria Property

Gets or sets the value used in the criterion for the data validation.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
ValueObject Criteria { get; set; }
vb
Property Criteria As ValueObject

Property Value

TypeDescription
ValueObject

A ValueObject instance.

|

Remarks

The Criteria value is used as one of the bounds for DataValidationOperator.Between and DataValidationOperator.NotBetween operators, and the only value or formula used for other DataValidationOperator types, or for DataValidationType.Custom or DataValidationType.List type data validation.

The content specified by the Criteria property can be a formula, a constant, a worksheet cell or range, or a list series (comma separated values).

Since the ValueObject class provides implicit constructors for most types, you can assign a numerical, text, boolean or DateTime value directly to the Criteria property. For the worksheet range or formula, use the ValueObject.FromRange or ValueObject.FromFormula methods, respectively.

Example

View Example

csharp
workbook.LoadDocument("Documents\\DataValidation.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

// Restrict data entry to a number within limits.
DataValidation validation = worksheet.DataValidations.Add(worksheet["F4:F11"], DataValidationType.Decimal, DataValidationOperator.Between, 10, 40);

// Change the validation operator and criteria.
// Range F4:F11 should contain numbers greater than or equal 20.
validation.Operator = DataValidationOperator.GreaterThanOrEqual;
validation.Criteria = 20;
validation.Criteria2 = ValueObject.Empty;

// Highlight data validation ranges.
int[] MyColorScheme = new int[] { 0xFFC4C4, 0xFFD9D9, 0xFFF6F6, 0xFFECEC, 0xE9D3D3 };
for (int i = 0; i < worksheet.DataValidations.Count; i++)
{
    worksheet.DataValidations[i].Range.FillColor = Color.FromArgb(MyColorScheme[i]);
}
vb
workbook.LoadDocument("Documents\DataValidation.xlsx")
Dim worksheet As Worksheet = workbook.Worksheets(0)

' Restrict data entry to a number within limits.
Dim validation As DataValidation = worksheet.DataValidations.Add(worksheet("F4:F11"), DataValidationType.Decimal, DataValidationOperator.Between, 10, 40)

' Change the validation operator and criteria.
' Range F4:F11 should contain numbers greater than or equal 20.
validation.Operator = DataValidationOperator.GreaterThanOrEqual
validation.Criteria = 20
validation.Criteria2 = ValueObject.Empty

' Highlight data validation ranges.
Dim MyColorScheme() As Integer = { &HFFC4C4, &HFFD9D9, &HFFF6F6, &HFFECEC, &HE9D3D3 }
For i As Integer = 0 To worksheet.DataValidations.Count - 1
    worksheet.DataValidations(i).Range.FillColor = Color.FromArgb(MyColorScheme(i))
Next i

The following code snippets (auto-collected from DevExpress Examples) contain references to the Criteria property.

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.

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

csharp
validation.Operator = DataValidationOperator.GreaterThanOrEqual;
validation.Criteria = 20;
validation.Criteria2 = ValueObject.Empty;

wpf-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/DataValidationActions.cs#L72

csharp
validation.Operator = DataValidationOperator.GreaterThanOrEqual;
validation.Criteria = 20;
validation.Criteria2 = ValueObject.Empty;

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/DataValidationActions.cs#L83

csharp
validation.Operator = DataValidationOperator.GreaterThanOrEqual;
validation.Criteria = 20;
validation.Criteria2 = ValueObject.Empty;

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

vb
validation.[Operator] = DevExpress.Spreadsheet.DataValidationOperator.GreaterThanOrEqual
validation.Criteria = 20
validation.Criteria2 = DevExpress.Spreadsheet.ValueObject.Empty

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/DataValidationActions.vb#L80

vb
validation.Operator = DataValidationOperator.GreaterThanOrEqual
validation.Criteria = 20
validation.Criteria2 = ValueObject.Empty

See Also

DataValidation Interface

DataValidation Members

DevExpress.Spreadsheet Namespace