ClassDataValidationRuleBase
Abstract base for data validation rules, providing common infrastructure for input messages, error alerts, and validation evaluation.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model.DataValidation
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public abstract class DataValidationRuleBase : IDataValidationRuleInheritance: objectDataValidationRuleBase
Derived Classes:
Implements:
Constructors
DataValidationRuleBase(DataValidationRuleContextBase)
Initializes a new DataValidationRuleBase from the specified configuration context.
Declaration
protected DataValidationRuleBase(DataValidationRuleContextBase context)Parameters
context
The context.
Properties
ErrorAlertContent
Descriptive text in the error alert explaining why the input was rejected.
Declaration
public string ErrorAlertContent { get; }Property Value
The content of the error alert.
Implements
ErrorAlertTitle
Title text displayed in the error alert dialog when validation fails.
Declaration
public string ErrorAlertTitle { get; }Property Value
The error alert title.
Implements
ErrorStyle
Severity level of the error alert, determining whether invalid input is blocked or allowed.
Declaration
public ErrorStyle ErrorStyle { get; }Property Value
The error style.
Implements
InputMessageContent
Descriptive text in the input prompt explaining valid values or constraints to the user.
Declaration
public string InputMessageContent { get; }Property Value
The content of the input message.
Implements
InputMessageTitle
Title text displayed in the input prompt when the user selects a validated cell.
Declaration
public string InputMessageTitle { get; }Property Value
The input message title.
Implements
ShowErrorMessage
Indicates whether an error alert is displayed when the user enters invalid data.
Declaration
public bool ShowErrorMessage { get; }Property Value
The value indicating whether an input message should be shown.
Implements
ShowInputMessage
Indicates whether an input prompt is displayed when the cell is selected, guiding users on valid input.
Declaration
public bool ShowInputMessage { get; }Property Value
The value indicating whether an input message should be shown.
Implements
Methods
Evaluate(Worksheet, int, int, ICellValue)
Evaluates whether the specified cell value satisfies the validation rule and returns the validation result.
Declaration
public 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
Returns
Retrurns True if the rule is satisfied, else returns False.
Implements
EvaluateOverride(Worksheet, int, int, ICellValue)
Override to implement rule-specific validation logic that determines whether the cell value is valid.
Declaration
protected abstract bool EvaluateOverride(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.
GetHashCode()
Serves as a hash function for a particular type.