ClassRadCheckedDropDownList
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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
[ComplexBindingProperties("DataSource", "ValueMember")]
[LookupBindingProperties("DataSource", "DisplayMember", "ValueMember", "SelectedValue")]
[DefaultBindingProperty("Text")]
public class RadCheckedDropDownList : RadDropDownList, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, ISupportRootUIAutomation
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadEditorControlRadDropDownListRadCheckedDropDownList
Implements:
Inherited Members
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
[Browsable(true)]
public override AutoCompleteMode AutoCompleteMode { get; set; }
Property Value
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
CheckedDropDownListElement
Gets the instance of RadCheckedDropDownListElement that provides the core functionality for this control.
Declaration
[Browsable(false)]
public RadCheckedDropDownListElement CheckedDropDownListElement { get; set; }
Property Value
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
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.
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
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
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
[Browsable(true)]
public bool Multiline { get; set; }
Property Value
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
[Browsable(true)]
public override bool ReadOnly { get; set; }
Property Value
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
[Browsable(true)]
public bool ShowCheckAllItems { get; set; }
Property Value
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
[Browsable(true)]
public bool SyncSelectionWithText { get; set; }
Property Value
TabStop
Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.
Declaration
[Browsable(true)]
public bool TabStop { get; set; }
Property Value
ThemeClassName
Gets the name of the theme class used for styling this control.
Declaration
public override string ThemeClassName { get; }
Property Value
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
element
The RadElement to check.
Returns
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
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.
OnGotFocus(EventArgs)
Raises the GotFocus event and focuses the auto-complete text box.
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 Value
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 Value
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 Value
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 Value
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 Value
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 Value
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 Value