CheckState Property (ValueListItem)

Returns or sets the value displayed by the check box associated with this item.
Public Property CheckState As CheckState
public CheckState CheckState {get; set;}

Checkboxes are only displayed by the standard dropdown used by the EditorWithCombo embeddable editor. Other representations of a ValueListItem, such as when used by the OptionSetEditor, do not provide a user interface through which this property can be modified. The value of the CheckState property will be maintained and serialized in all cases, but user interface support for displaying and changing the value is only extended by the standard dropdown used by the EditorWithCombo.

The EditorWithCombo embeddable editor uses the checkbox support provided by the ValueList class to return a value that consists of the DataValues of multiple items, effectively enabling "multiple selection" of items.

A collection containing only the items whose CheckState is set to 'Checked' is returned by the ValueList's CheckedItems collection.


Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also