Class DataValidationRuleBase

Abstract base for data validation rules, providing common infrastructure for input messages, error alerts, and validation evaluation.

Inheritance
System.Object
DataValidationRuleBase
AnyValueDataValidationRule
SingleArgumentDataValidationRuleBase
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.DataValidation
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class DataValidationRuleBase : IDataValidationRule

Constructors

DataValidationRuleBase(DataValidationRuleContextBase)

Initializes a new DataValidationRuleBase from the specified configuration context.

Declaration
protected DataValidationRuleBase(DataValidationRuleContextBase context)
Parameters
DataValidationRuleContextBase context

The context.

Properties

ErrorAlertContent

Descriptive text in the error alert explaining why the input was rejected.

Declaration
public string ErrorAlertContent { get; }
Property Value
System.String

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
System.String

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
ErrorStyle

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
System.String

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
System.String

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
System.Boolean

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
System.Boolean

The value indicating whether an input message should be shown.
Implements

Methods

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

true if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

Evaluate(Worksheet, Int32, Int32, 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 worksheet

The worksheet.
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
ICellValue cellValue

Returns
System.Boolean

Retrurns True if the rule is satisfied, else returns False.
Implements

EvaluateOverride(Worksheet, Int32, Int32, 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 worksheet

The worksheet.
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
ICellValue cellValue

The cell value.
Returns
System.Boolean

Retrurns True if the rule is satisfied, else returns False.

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()