DataValidationCollection.GetDataValidations(DataValidationType, DataValidationOperator, ValueObject, ValueObject) Method

Obtains data validation entries with the specified properties.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

IList<DataValidation> GetDataValidations(
    DataValidationType validationType,
    DataValidationOperator validationOperator,
    ValueObject criteria,
    ValueObject criteria2
)

VB.NET

Function GetDataValidations(
    validationType As DataValidationType,
    validationOperator As DataValidationOperator,
    criteria As ValueObject,
    criteria2 As ValueObject
) As IList(Of DataValidation)

Parameters

Name	Type	Description
validationType	DataValidationType	A DataValidationType enumeration member that specifies the validation type.
validationOperator	DataValidationOperator	A DataValidationOperator enumeration member that specifies the operator used in a criteria expression.
criteria	ValueObject	A ValueObject that is the value used in the criterion.
criteria2	ValueObject	A ValueObject that is the value used in the criterion.

Returns

Type	Description
IList<DataValidation>	A IList<T><DataValidation,> collection of data validation entries.

Example

View Example

DataValidationActions.cs

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

// Add data validations.
worksheet.DataValidations.Add(worksheet["D4:D11"], DataValidationType.TextLength, DataValidationOperator.Equal, 3);
worksheet.DataValidations.Add(worksheet["E4:E11"], DataValidationType.List, ValueObject.FromRange(worksheet["H4:H9"].GetRangeWithAbsoluteReference()));

// Get data validation entry associated with a particular cell.
worksheet.DataValidations.GetDataValidation(worksheet.Cells["E4"]).Criteria = ValueObject.FromRange(worksheet["H4:H5"]);

// Get data validation entries for the specified range.
var myValidation = worksheet.DataValidations.GetDataValidations(worksheet["D4:E11"])
    .Where(d => d.ValidationType == DataValidationType.TextLength).SingleOrDefault();
if (myValidation != null) myValidation.Criteria = 4;

// Get data validation entries that meet certain criteria.
foreach (var d in worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty))
{
    // Change criteria operator.
    // Range D4:D11 should contain text with more than 4 characters.
    d.Operator = DataValidationOperator.GreaterThan;
}              

// 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]);
}

DataValidationActions.vb

workbook.LoadDocument("Documents\DataValidation.xlsx")
Dim worksheet As Worksheet = workbook.Worksheets(0)

' Add data validations.
worksheet.DataValidations.Add(worksheet("D4:D11"), DataValidationType.TextLength, DataValidationOperator.Equal, 3)
worksheet.DataValidations.Add(worksheet("E4:E11"), DataValidationType.List, ValueObject.FromRange(worksheet("H4:H9").GetRangeWithAbsoluteReference()))

' Get data validation entry associated with a particular cell.
worksheet.DataValidations.GetDataValidation(worksheet.Cells("E4")).Criteria = ValueObject.FromRange(worksheet("H4:H5"))

' Get data validation entries for the specified range.
Dim myValidation = worksheet.DataValidations.GetDataValidations(worksheet("D4:E11")).Where(Function(d) d.ValidationType = DataValidationType.TextLength).SingleOrDefault()
If myValidation IsNot Nothing Then
    myValidation.Criteria = 4
End If

' Get data validation entries that meet certain criteria.
For Each d In worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty)
    ' Change criteria operator.
    ' Range D4:D11 should contain text with more than 4 characters.
    d.Operator = DataValidationOperator.GreaterThan
Next d

' 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDataValidations(DataValidationType, DataValidationOperator, ValueObject, 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/CS/SpreadsheetControl_WPF_API_Part03/CodeExamples/DataValidationActions.cs#L156

// Get data validation entries that meet certain criteria.
foreach (var d in worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty))
{

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

// Get data validation entries that meet certain criteria.
foreach (var d in worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty))
{

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

// Get data validation entries that meet a specific criteria.
foreach (var d in worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty))
{

VB.NET

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

' Get data validation entries that meet certain criteria.
For Each d In worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty)
    ' Change criteria operator.

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

' Get data validation entries that meet certain criteria.
For Each d In worksheet.DataValidations.GetDataValidations(DevExpress.Spreadsheet.DataValidationType.TextLength, DevExpress.Spreadsheet.DataValidationOperator.Equal, 4, DevExpress.Spreadsheet.ValueObject.Empty)
    ' Change criteria operator.

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

' Get data validation entries that meet a specific criteria.
Dim textLenValidations = worksheet.DataValidations.GetDataValidations(DataValidationType.TextLength, DataValidationOperator.Equal, 4, ValueObject.Empty)
For i As Integer = 0 To textLenValidations.Count - 1