DataValidation.ShowInputMessage Property

Gets or sets whether to display the message prompting the user for data input.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool ShowInputMessage { get; set; }

VB.NET

Property ShowInputMessage As Boolean

Property Value

Type	Description
Boolean	true, to display the message; otherwise, false.

Example

View Example

DataValidationActions.cs

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 input message.
validation.InputTitle = "Employee Id";
validation.InputMessage = "Please enter 5-digit number";
validation.ShowInputMessage = 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]);
}

DataValidationActions.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 input message.
validation.InputTitle = "Employee Id"
validation.InputMessage = "Please enter 5-digit number"
validation.ShowInputMessage = 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowInputMessage 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.

C#

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

validation.InputMessage = "Please enter 5-digit number";
validation.ShowInputMessage = true;

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

validation.InputMessage = "Please enter 5-digit number";
validation.ShowInputMessage = true;

VB.NET

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

validation.InputMessage = "Please enter 5-digit number"
validation.ShowInputMessage = True
' Highlight data validation ranges.

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

validation.InputMessage = "Please enter 5-digit number"
validation.ShowInputMessage = True