ClassRadItemsControl
Provides an abstract base class for RadControls that manage collections of RadItem objects, offering item selection, event handling, and collection management capabilities.
Definition
Namespace:Telerik.WinControls
Assembly:Telerik.WinControls.dll
Syntax:
public abstract class RadItemsControl : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, IItemsControlInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadItemsControl
Derived Classes:
Implements:
Inherited Members
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
Gets a collection containing the items that are currently active.
Declaration
public virtual RadItemOwnerCollection ActiveItems { get; }Property Value
Implements
Items
Gets the collection of items associated with the IItemsControl.
Declaration
public abstract RadItemOwnerCollection Items { get; }Property Value
Implements
ProcessKeyboard
Gets or sets whether the RadItemsControl processes the keyboard.
Declaration
[Browsable(false)]
public virtual bool ProcessKeyboard { get; set; }Property Value
Implements
RollOverItemSelection
Gets or sets whether the rollover items functionality of the RadItemsControl will be allowed.
Declaration
[Browsable(false)]
public virtual bool RollOverItemSelection { get; set; }Property Value
Implements
Methods
CallOnItemDeselected(ItemSelectedEventArgs)
Declaration
public void CallOnItemDeselected(ItemSelectedEventArgs args)Parameters
args
CanNavigate(Keys)
Defines whether the IItemsControl can execute navigation operation based on the keydata provided.
CanProcessMnemonic(char)
Defines whether the IItemsControl has an item that corresponds to the mnemonic passed in the parameter.
ChangeSelection(RadItem)
Declaration
protected virtual void ChangeSelection(RadItem nextItem)Parameters
nextItem
GetChildMnemonicList(ArrayList)
Declaration
protected virtual void GetChildMnemonicList(ArrayList mnemonicList)Parameters
mnemonicList
GetFirstVisibleItem()
Gets the first visible item from the collection. In a IItemsControl that is the first item that is visible on the control.
Declaration
public virtual RadItem GetFirstVisibleItem()Returns
A reference to a RadItem instance that represents the first visible control.
Implements
GetInputElement()
Declaration
protected override RadElement GetInputElement()Returns
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
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()
Gets the last visible item from the collection. In a IItemsControl that is the last item that is visible on the control.
Declaration
public virtual RadItem GetLastVisibleItem()Returns
A reference to a RadItem instance that represents the last visible control.
Implements
GetNextItem(RadItem, bool)
Gets an item from the collection that is next to a certain item.
Declaration
public virtual RadItem GetNextItem(RadItem item, bool forward)Parameters
item
The item which neighbour to return.
forward
The direction in which to look for the neighbour.
Returns
A reference to a RadItem instance which represents the neighbour item.
Implements
GetSelectedItem()
Returns the selected item in the control.
Declaration
public virtual RadItem GetSelectedItem()Returns
An reference to a RadItem instance which represents the currently selected item.
Implements
OnGotFocus(EventArgs)
Declaration
protected override void OnGotFocus(EventArgs e)Parameters
e
Overrides
OnItemDeselected(ItemSelectedEventArgs)
Declaration
protected virtual void OnItemDeselected(ItemSelectedEventArgs args)Parameters
args
OnItemSelected(ItemSelectedEventArgs)
Declaration
protected virtual void OnItemSelected(ItemSelectedEventArgs args)Parameters
args
SelectFirstVisibleItem()
Selects the first visible item on the IItemsControl.
Declaration
public virtual RadItem SelectFirstVisibleItem()Returns
A reference to a RadItem instance that represents the item selected.
Implements
SelectItem(RadItem)
Selects an item in the control.
Declaration
public virtual void SelectItem(RadItem item)Parameters
item
A reference to a RadItem instance which represents the item which is to be selected.
Implements
SelectLastVisibleItem()
Selects the last visible item on the IItemsControl.
Declaration
public virtual RadItem SelectLastVisibleItem()Returns
A reference to a RadItem instance that represents the item selected.
Implements
SelectNextItem(RadItem, bool)
Selects an item from the collection that is next to a certain item.
Declaration
public virtual RadItem SelectNextItem(RadItem item, bool forward)Parameters
item
The item which neighbour to return.
forward
The direction in which to look for the neighbour.
Returns
A reference to a RadItem instance which represents the neighbour item.
Implements
Events
ItemDeselected
Occurs when an item becomes deselected in the control.
Declaration
public event ItemSelectedEventHandler ItemDeselectedEvent Value
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 ItemSelectedEvent Value
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.