InterfaceIDataValidationRule
Contract for data validation rules that validate cell values and provide input prompts and error alerts.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model.DataValidation
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public interface IDataValidationRule
Properties
ErrorAlertContent
Descriptive text in the error alert explaining why the input was rejected.
Declaration
string ErrorAlertContent { get; }
Property Value
The content of the error alert.
ErrorAlertTitle
Title text displayed in the error alert dialog when validation fails.
Declaration
string ErrorAlertTitle { get; }
Property Value
The error alert title.
ErrorStyle
Severity level of the error alert, determining whether invalid input is blocked or allowed.
Declaration
ErrorStyle ErrorStyle { get; }
Property Value
The error style.
InputMessageContent
Descriptive text in the input prompt explaining valid values or constraints to the user.
Declaration
string InputMessageContent { get; }
Property Value
The content of the input message.
InputMessageTitle
Title text displayed in the input prompt when the user selects a validated cell.
Declaration
string InputMessageTitle { get; }
Property Value
The input message title.
ShowErrorMessage
Indicates whether an error alert is displayed when the user enters invalid data.
Declaration
bool ShowErrorMessage { get; }
Property Value
The value indicating whether an input message should be shown.
ShowInputMessage
Indicates whether an input prompt is displayed when the cell is selected, guiding users on valid input.
Declaration
bool ShowInputMessage { get; }
Property Value
The value indicating whether an input message should be shown.
Methods
Evaluate(Worksheet, int, int, ICellValue)
Evaluates whether the specified cell value satisfies the validation rule and returns the validation result.
Declaration
bool Evaluate(Worksheet worksheet, int rowIndex, int columnIndex, ICellValue cellValue)
Parameters
worksheet
The worksheet.
rowIndex
Index of the row.
columnIndex
Index of the column.
cellValue
The cell value.
Returns
Retrurns True if the rule is satisfied, else returns False.