Candidates Property (IncludeListValidator)

Gets or sets a System.String array that indicates the specified values included in the candidate strings.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Candidates As String()

'Usage
 
Dim instance As IncludeListValidator
Dim value() As String
 
instance.Candidates = value
 
value = instance.Candidates

public string[] Candidates {get; set;}

Property Value

A System.String array that indicates the candidate strings. The default is a null reference (Nothing in Visual Basic).

Example

This example creates a validator with a list of valid items.

//Type an item in cell 1,1 that is not in the list to see the error notification
FarPoint.Win.Spread.CellStyleNotify cnotify = new FarPoint.Win.Spread.CellStyleNotify();
cnotify.InvalidCellStyle.BackColor = Color.Yellow;
FarPoint.Win.Spread.IncludeListValidator ilist = new FarPoint.Win.Spread.IncludeListValidator();
ilist.Candidates = new string[] { "Bird", "Deer", "Squirrel", "Lizard" };           
ilist.Actions.Add(cnotify);
fpSpread1.Sheets[0].AddValidators(new FarPoint.Win.Spread.Model.CellRange(1, 1, 1, 1), ilist);

Visual Basic

'Type an item in cell 1,1 that is not in the list to see the error notification
Dim cnotify As New FarPoint.Win.Spread.CellStyleNotify()
cnotify.InvalidCellStyle.BackColor = Color.Yellow
Dim IList As New FarPoint.Win.Spread.IncludeListValidator()
IList.Candidates = New String() {"Bird", "Deer", "Squirrel", "Lizard"}
IList.Actions.Add(cnotify)
FpSpread1.Sheets(0).AddValidators(New FarPoint.Win.Spread.Model.CellRange(1, 1, 1, 1), IList)

Reference

IncludeListValidator Class
IncludeListValidator Members
Using Validation in Cells