Class RadCheckedDropDownList

Represents a CheckedDropDown List control that allows multiple item selection through checkboxes. The RadCheckedDropDownList class is a specialized version of RadDropDownList that wraps the RadCheckedDropDownListElement. This control provides functionality for displaying a list of items with checkboxes that can be individually selected.

Inheritance
System.Object
RadControl
RadEditorControl
RadDropDownList
RadCheckedDropDownList
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadCheckedDropDownList : RadDropDownList, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, ISupportRootUIAutomation

Constructors

RadCheckedDropDownList()

Initializes a new instance of the RadCheckedDropDownList class with default settings. Sets the dropdown style to DropDownList and enables tab navigation.

Declaration
public RadCheckedDropDownList()

Properties

AutoCompleteMode

Gets or sets the mode for the automatic completion feature used in the checked dropdown list. This determines how the control suggests completions as the user types.

Declaration
public override AutoCompleteMode AutoCompleteMode { get; set; }
Property Value
System.Windows.Forms.AutoCompleteMode

Overrides

AutoCompleteTextBoxElement

Gets the RadAutoCompleteBoxElement associated with this control. This element provides the auto-complete text box functionality.

Declaration
protected RadAutoCompleteBoxElement AutoCompleteTextBoxElement { get; }
Property Value
RadAutoCompleteBoxElement

CaseSensitive

This property is not relevant for this class.

Declaration
[RadDescription("CaseSensitive", typeof(RadDropDownListElement))]
public override bool CaseSensitive { get; set; }
Property Value
System.Boolean

Overrides

CheckedDropDownListElement

Gets the instance of RadCheckedDropDownListElement that provides the core functionality for this control.

Declaration
public RadCheckedDropDownListElement CheckedDropDownListElement { get; set; }
Property Value
RadCheckedDropDownListElement

CheckedItems

Gets a collection of items that are currently checked in this RadCheckedDropDownList. This collection only contains the items that have been selected by the user.

Declaration
public DropDownCheckedItemsCollection CheckedItems { get; }
Property Value
DropDownCheckedItemsCollection

CheckedMember

Gets or sets the name of the property in the data source that determines the checked state of items. When binding to a data source, this property specifies which field should be used to determine if an item is checked or unchecked.

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

DropDownStyle

This property is not relevant for this class.

Declaration
[RadPropertyDefaultValue("DropDownStyle", typeof(RadDropDownListElement))]
public override RadDropDownStyle DropDownStyle { get; set; }
Property Value
RadDropDownStyle

Overrides

Items

Gets a collection of items contained in this RadCheckedDropDownList. This collection includes all items that can be checked or unchecked in the list.

Declaration
public RadCheckedListDataItemCollection Items { get; }
Property Value
RadCheckedListDataItemCollection

MaxLength

Gets or sets the maximum number of characters the user can type or paste into the text box control. The default value is the maximum possible integer (2,147,483,647).

Declaration
public override int MaxLength { get; set; }
Property Value
System.Int32

Overrides

Multiline

Gets or sets a value indicating whether the hosted textbox supports multiple lines of text. When set to true, the textbox can display multiple lines and accept line breaks.

Declaration
public bool Multiline { get; set; }
Property Value
System.Boolean

ReadOnly

Gets or sets a value indicating whether the dropdown list is read-only. When set to true, users cannot modify the text in the textbox, but can still check/uncheck items.

Declaration
public override bool ReadOnly { get; set; }
Property Value
System.Boolean

Overrides

SelectedIndex

This property is not relevant for this class. Please use CheckedItems instead.

Declaration
public override int SelectedIndex { get; set; }
Property Value
System.Int32

Overrides

SelectedItem

This property is not relevant for this class. Please use CheckedItems instead.

Declaration
public override RadListDataItem SelectedItem { get; set; }
Property Value
RadListDataItem

Overrides

SelectedValue

This property is not relevant for this class. Please use CheckedItems instead.

Declaration
public override object SelectedValue { get; set; }
Property Value
System.Object

Overrides

ShowCheckAllItems

Gets or sets a value indicating whether to display a "Check All" item in the dropdown list. When enabled, this adds an item at the top of the list that allows users to check or uncheck all items at once.

Declaration
public bool ShowCheckAllItems { get; set; }
Property Value
System.Boolean

SyncSelectionWithText

Gets or sets a value indicating whether the checked state of items is synchronized with the text in the editable area. When true, the text displayed in the textbox reflects the checked items in the dropdown list.

Declaration
public bool SyncSelectionWithText { get; set; }
Property Value
System.Boolean

TabStop

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

Declaration
public bool TabStop { get; set; }
Property Value
System.Boolean

ThemeClassName

Gets the name of the theme class used for styling this control.

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

The fully qualified name of the RadDropDownList type.
Overrides

Methods

BeginInit()

Begins the initialization of the RadCheckedDropDownList control.

Declaration
public override void BeginInit()
Overrides

CanEditElementAtDesignTime(RadElement)

Determines whether an element can be edited at design time.

Declaration
protected override bool CanEditElementAtDesignTime(RadElement element)
Parameters
RadElement element

The RadElement to check.
Returns
System.Boolean

true if the element can be edited at design time; otherwise, false.
Overrides

CreateDropDownListElement()

Creates the RadCheckedDropDownListElement that is wrapped by this control.

Declaration
protected override RadDropDownListElement CreateDropDownListElement()
Returns
RadDropDownListElement

A new instance of RadCheckedDropDownListElement.
Overrides

EndInit()

Ends the initialization of the RadCheckedDropDownList control.

Declaration
public override void EndInit()
Overrides

OnEnter(EventArgs)

Raises the Enter event when the control is entered.

Declaration
protected override void OnEnter(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnGotFocus(EventArgs)

Raises the GotFocus event and focuses the auto-complete text box.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

ResetBackColorThemeOverrides()

Resets theme overrides for the BackColor property to their default values.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Resets theme overrides for the ForeColor property to their default values.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Sets theme overrides for the BackColor property across all visual elements of the control.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Sets theme overrides for the ForeColor property across all visual elements of the control.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

Events

CheckAllItemCheckedChanged

Occurs when the "Check All" item has its checked state changed. This event is raised after the state has been changed and all items have been affected.

Declaration
public event RadCheckedListDataItemEventHandler CheckAllItemCheckedChanged
Event Type
RadCheckedListDataItemEventHandler

CheckAllItemCheckedChanging

Occurs when the "Check All" item is about to have its checked state changed. This event can be canceled to prevent the state change, which would otherwise affect all items in the list.

Declaration
public event RadCheckedListDataItemCancelEventHandler CheckAllItemCheckedChanging
Event Type
RadCheckedListDataItemCancelEventHandler

CreateTextBlock

Occurs when an instance of ITextBlock is being created. This event allows customization of text blocks during their creation.

Declaration
public event CreateTextBlockEventHandler CreateTextBlock
Event Type
CreateTextBlockEventHandler

ItemCheckedChanged

Occurs when a ListViewDataItem has its checked state changed. This event is raised after the item's checked state has been modified.

Declaration
public event RadCheckedListDataItemEventHandler ItemCheckedChanged
Event Type
RadCheckedListDataItemEventHandler

ItemCheckedChanging

Occurs when a ListViewDataItem is about to have its checked state changed. This event can be canceled to prevent the state change.

Declaration
public event RadCheckedListDataItemCancelEventHandler ItemCheckedChanging
Event Type
RadCheckedListDataItemCancelEventHandler

TextBlockFormatting

Occurs when a text block is formatting. This event allows customization of how text blocks are displayed in the control.

Declaration
public event TextBlockFormattingEventHandler TextBlockFormatting
Event Type
TextBlockFormattingEventHandler

TokenValidating

Occurs when text is being validated as a token. This event allows custom validation of text before it becomes a token.

Declaration
public event TokenValidatingEventHandler TokenValidating
Event Type
TokenValidatingEventHandler

Extension Methods