New to Telerik Document Processing? Start a free 30-day trial

ListDataValidationRule

Class

Validates that cell input matches one of the values in a specified list or range.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.DataValidation

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public sealed class ListDataValidationRule : SingleArgumentDataValidationRuleBase, IDataValidationRule

Inheritance: objectDataValidationRuleBaseSingleArgumentDataValidationRuleBaseListDataValidationRule

Implements: IDataValidationRule

Inherited Members SingleArgumentDataValidationRuleBase.IgnoreBlankSingleArgumentDataValidationRuleBase.CellIndexSingleArgumentDataValidationRuleBase.Argument1DataValidationRuleBase.Evaluate(Worksheet, int, int, ICellValue)DataValidationRuleBase.ShowInputMessageDataValidationRuleBase.InputMessageTitleDataValidationRuleBase.InputMessageContentDataValidationRuleBase.ShowErrorMessageDataValidationRuleBase.ErrorStyleDataValidationRuleBase.ErrorAlertTitleDataValidationRuleBase.ErrorAlertContent...

Constructors

ListDataValidationRule(ListDataValidationRuleContext)

Initializes a new ListDataValidationRule with the specified list source and dropdown settings.

public ListDataValidationRule(ListDataValidationRuleContext context)

Parameters:contextListDataValidationRuleContext

The context.

Methods

Equals(object)

bool

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters:objobject

The object to compare with the current object.

Returns:

bool

true if the specified object is equal to the current object; otherwise, false.

Overrides: SingleArgumentDataValidationRuleBase.Equals(object)

EvaluateOverride(Worksheet, int, int, ICellValue)

bool

Evaluates whether the specified cell value matches any item in the list.

protected override bool EvaluateOverride(Worksheet worksheet, int rowIndex, int columnIndex, ICellValue cellValue)

Parameters:worksheetWorksheet

The worksheet.

rowIndexint

Index of the row.

columnIndexint

Index of the column.

cellValueICellValue

The cell value.

Returns:

bool

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

Overrides: DataValidationRuleBase.EvaluateOverride(Worksheet, int, int, ICellValue)

ExtractListItems(Worksheet, CellIndex)

IEnumerable<string>

Extracts the list items defined by this rule for the specified cell location.

public IEnumerable<string> ExtractListItems(Worksheet worksheet, CellIndex cellIndex)

Parameters:worksheetWorksheet

The worksheet.

cellIndexCellIndex

Index of the cell.

Returns:

IEnumerable<string>

ExtractListItems(Worksheet, int, int)

IEnumerable<string>

Extracts the list items defined by this rule for the specified cell location.

public IEnumerable<string> ExtractListItems(Worksheet worksheet, int rowIndex, int columnIndex)

Parameters:worksheetWorksheet

The worksheet.

rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

IEnumerable<string>

GetHashCode()

int

Serves as a hash function for a particular type.

public override int GetHashCode()

Returns:

int

A hash code for the current object.

Overrides: SingleArgumentDataValidationRuleBase.GetHashCode()

Properties

InCellDropdown

bool

Controls whether a dropdown arrow appears in the cell to display available list values.

public bool InCellDropdown { get; set; }

Property Value:

The a value indicating if an cell dropdown should be shown.