Back to Devexpress

DataValidation.ShowErrorMessage Property

officefileapi-devexpress-dot-spreadsheet-dot-datavalidation-787c2406.md

latest6.1 KB
Original Source

DataValidation.ShowErrorMessage Property

Gets or sets whether to display the error alert when the user input is not valid.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
bool ShowErrorMessage { get; set; }
vb
Property ShowErrorMessage As Boolean

Property Value

TypeDescription
Boolean

true , to display the alert message if the value is not valid; otherwise, false.

|

Example

The following code snippet adds a new data validation rule and customizes the error dialog invoked when validation fails for the user’s input.

The customized dialog is shown in the image below.

View Example

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

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

// Show error message.
validation.ErrorTitle = "Wrong Employee Id";
validation.ErrorMessage = "The value you entered is not valid. Use 5-digit number for the employee ID.";
validation.ErrorStyle = DataValidationErrorStyle.Information;
validation.ShowErrorMessage = true;

// 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 5-digit number.
Dim validation As DataValidation = worksheet.DataValidations.Add(worksheet("B4:B11"), DataValidationType.Custom, "=AND(ISNUMBER(B4),LEN(B4)=5)")

' Show error message.
validation.ErrorTitle = "Wrong Employee Id"
validation.ErrorMessage = "The value you entered is not valid. Use 5-digit number for the employee ID."
validation.ErrorStyle = DataValidationErrorStyle.Information
validation.ShowErrorMessage = True

' 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 ShowErrorMessage 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#L125

csharp
validation.ErrorStyle = DataValidationErrorStyle.Information;
validation.ShowErrorMessage = true;

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

csharp
validation.ErrorStyle = DataValidationErrorStyle.Information;
validation.ShowErrorMessage = true;

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

csharp
validation.ErrorStyle = DataValidationErrorStyle.Information;
validation.ShowErrorMessage = true;

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

vb
validation.ErrorStyle = DevExpress.Spreadsheet.DataValidationErrorStyle.Information
validation.ShowErrorMessage = True
' Highlight data validation ranges.

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

vb
validation.ErrorStyle = DataValidationErrorStyle.Information
validation.ShowErrorMessage = True

See Also

DataValidation Interface

DataValidation Members

DevExpress.Spreadsheet Namespace