DataValidation.InputMessage Property

Gets or sets the message text of the input prompt message.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

string InputMessage { get; set; }

VB.NET

Property InputMessage As String

Property Value

Type	Description
String	A string that specifies the text of the dialog.

Remarks

The input prompt message is displayed near the cell, as shown below:

Use the DataValidation.ShowInputMessage property to display or hide it.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-part-3-t231273

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 InputMessage 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#

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

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

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

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

VB.NET

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

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

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

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