Class RadItemsControl

Provides an abstract base class for RadControls that manage collections of RadItem objects, offering item selection, event handling, and collection management capabilities.

Inheritance
System.Object
RadControl
RadItemsControl
RadMenu
Inherited Members
Namespace: Telerik.WinControls
Assembly: Telerik.WinControls.dll

Syntax

public abstract class RadItemsControl : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, IItemsControl
Remarks

RadItemsControl serves as the foundation for controls that work with collections of interactive items such as list boxes, combo boxes, menus, toolbars, and tree views. It provides a unified programming model for item-based controls through the IItemsControl interface.

The class manages item selection state through ItemSelected and ItemDeselected events, coordinates with implementation objects for specialized behavior, and provides infrastructure for item collection management. It delegates specific functionality to implementation classes while maintaining a consistent public interface.

Derived classes include RadListControl, RadComboBox, RadMenu, and other controls that need to manage collections of selectable or interactive items with consistent behavior patterns and event handling throughout the Telerik WinControls framework.

Constructors

RadItemsControl()

Initializes a new instance of the RadItemsControl class.

Declaration
public RadItemsControl()
Remarks

The constructor establishes the implementation pattern by creating an items control implementation object and wiring up the necessary event handlers for item selection and deselection events.

Properties

ActiveItems

Declaration
public virtual RadItemOwnerCollection ActiveItems { get; }
Property Value
RadItemOwnerCollection

Implements

HasKeyboardInput

Declaration
public virtual bool HasKeyboardInput { get; }
Property Value
System.Boolean

Items

Declaration
public abstract RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

Implements

ProcessKeyboard

Gets or sets whether the RadItemsControl processes the keyboard.

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

Implements

RollOverItemSelection

Gets or sets whether the rollover items functionality of the RadItemsControl will be allowed.

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

Implements

Methods

CallBaseProcessDialogKey(Keys)

Declaration
protected virtual bool CallBaseProcessDialogKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

CallOnItemDeselected(ItemSelectedEventArgs)

Declaration
public void CallOnItemDeselected(ItemSelectedEventArgs args)
Parameters
ItemSelectedEventArgs args

CanNavigate(Keys)

Declaration
public virtual bool CanNavigate(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Implements

CanProcessMnemonic(Char)

Declaration
public virtual bool CanProcessMnemonic(char keyData)
Parameters
System.Char keyData

Returns
System.Boolean

Implements

ChangeSelection(RadItem)

Declaration
protected virtual void ChangeSelection(RadItem nextItem)
Parameters
RadItem nextItem

GetChildMnemonicList(ArrayList)

Declaration
protected virtual void GetChildMnemonicList(ArrayList mnemonicList)
Parameters
System.Collections.ArrayList mnemonicList

GetFirstVisibleItem()

Declaration
public virtual RadItem GetFirstVisibleItem()
Returns
RadItem

Implements

GetInputElement()

Declaration
protected override RadElement GetInputElement()
Returns
RadElement

Overrides

GetItemsControlImpl()

When overridden in a derived class, creates and returns the implementation object that provides the specific behavior for this items control.

Declaration
protected virtual IItemsControl GetItemsControlImpl()
Returns
IItemsControl

An IItemsControl implementation that handles the specific behavior for this control type.
Remarks

This factory method allows derived classes to specify their own implementation objects while maintaining the common RadItemsControl interface and event handling patterns. The default implementation returns a RadItemsControlImpl instance.

GetLastVisibleItem()

Declaration
public virtual RadItem GetLastVisibleItem()
Returns
RadItem

Implements

GetNextItem(RadItem, Boolean)

Declaration
public virtual RadItem GetNextItem(RadItem item, bool forward)
Parameters
RadItem item

System.Boolean forward

Returns
RadItem

Implements

GetSelectedItem()

Declaration
public virtual RadItem GetSelectedItem()
Returns
RadItem

Implements

OnGotFocus(EventArgs)

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

Overrides

OnHandleKeyDown(Message)

Declaration
protected virtual bool OnHandleKeyDown(Message m)
Parameters
System.Windows.Forms.Message m

Returns
System.Boolean

OnItemDeselected(ItemSelectedEventArgs)

Declaration
protected virtual void OnItemDeselected(ItemSelectedEventArgs args)
Parameters
ItemSelectedEventArgs args

OnItemSelected(ItemSelectedEventArgs)

Declaration
protected virtual void OnItemSelected(ItemSelectedEventArgs args)
Parameters
ItemSelectedEventArgs args

ProcessArrowKey(Keys)

Declaration
protected virtual bool ProcessArrowKey(Keys keyCode)
Parameters
System.Windows.Forms.Keys keyCode

Returns
System.Boolean

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message m, Keys keyData)
Parameters
System.Windows.Forms.Message m

System.Windows.Forms.Keys keyData

Returns
System.Boolean

ProcessDialogKey(Keys)

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

ProcessLeftRightArrowKey(Boolean)

Declaration
protected virtual bool ProcessLeftRightArrowKey(bool right)
Parameters
System.Boolean right

Returns
System.Boolean

ProcessTabKey(Boolean)

Declaration
protected virtual bool ProcessTabKey(bool forward)
Parameters
System.Boolean forward

Returns
System.Boolean

ProcessUpDownArrowKey(Boolean)

Declaration
protected virtual bool ProcessUpDownArrowKey(bool down)
Parameters
System.Boolean down

Returns
System.Boolean

Select(Boolean, Boolean)

Declaration
protected override void Select(bool directed, bool forward)
Parameters
System.Boolean directed

System.Boolean forward

SelectFirstVisibleItem()

Declaration
public virtual RadItem SelectFirstVisibleItem()
Returns
RadItem

Implements

SelectItem(RadItem)

Declaration
public virtual void SelectItem(RadItem item)
Parameters
RadItem item

Implements

SelectLastVisibleItem()

Declaration
public virtual RadItem SelectLastVisibleItem()
Returns
RadItem

Implements

SelectNextItem(RadItem, Boolean)

Declaration
public virtual RadItem SelectNextItem(RadItem item, bool forward)
Parameters
RadItem item

System.Boolean forward

Returns
RadItem

Implements

Events

ItemDeselected

Occurs when an item becomes deselected in the control.

Declaration
public event ItemSelectedEventHandler ItemDeselected
Event Type
ItemSelectedEventHandler

Implements
Remarks

This event is raised whenever an item transitions from a selected to an unselected state, providing notification of deselection changes to enable cleanup operations and user interface state management.

ItemSelected

Occurs when an item becomes selected in the control.

Declaration
public event ItemSelectedEventHandler ItemSelected
Event Type
ItemSelectedEventHandler

Implements
Remarks

This event is raised whenever an item transitions from an unselected to a selected state, providing notification of selection changes to enable responsive user interface updates and business logic execution.

Extension Methods