Class
RadItemsControlImpl

Represents an encapsulated implementation of the IItemsControl interface. Provides core functionality for item selection, navigation, and keyboard processing in controls that manage collections of RadItem objects.

Definition

Namespace:Telerik.WinControls

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition
public class RadItemsControlImpl : IItemsControl

Inheritance: objectRadItemsControlImpl

Implements: IItemsControl

Constructors

RadItemsControlImpl(RadItemOwnerCollection)

Initializes a new instance of the RadItemsControlImpl class.

Declaration

cs-api-definition
public RadItemsControlImpl(RadItemOwnerCollection items)

Parameters

items

RadItemOwnerCollection

The collection of items to manage.

Properties

ActiveItems

Gets the collection of active items. This is an alias for the Items property.

Declaration

cs-api-definition
public RadItemOwnerCollection ActiveItems { get; }

Property Value

RadItemOwnerCollection

The collection of active RadItem objects.

Implements IItemsControl.ActiveItems

Items

Gets the collection of items managed by this control implementation.

Declaration

cs-api-definition
public RadItemOwnerCollection Items { get; }

Property Value

RadItemOwnerCollection

The RadItemOwnerCollection containing all managed items.

Implements IItemsControl.Items

ProcessKeyboard

Gets or sets a value indicating whether the control should process keyboard input.

Declaration

cs-api-definition
public bool ProcessKeyboard { get; set; }

Property Value

bool

true if keyboard processing is enabled; otherwise, false. The default value is false.

Implements IItemsControl.ProcessKeyboard

RollOverItemSelection

Gets or sets a value indicating whether item selection should roll over from the last item to the first item (and vice versa) during navigation.

Declaration

cs-api-definition
public bool RollOverItemSelection { get; set; }

Property Value

bool

true if rollover selection is enabled; otherwise, false. The default value is false.

Implements IItemsControl.RollOverItemSelection

Methods

CanNavigate(Keys)

Determines whether the control can navigate using the specified key.

Declaration

cs-api-definition
public bool CanNavigate(Keys keyData)

Parameters

keyData

Keys

The key to check for navigation capability.

Returns

bool

Always returns false in the current implementation.

Implements IItemsControl.CanNavigate(Keys)

CanProcessMnemonic(char)

Determines whether the control can process the specified mnemonic character.

Declaration

cs-api-definition
public bool CanProcessMnemonic(char keyData)

Parameters

keyData

char

The mnemonic character to check.

Returns

bool

Always returns false in the current implementation.

Implements IItemsControl.CanProcessMnemonic(char)

GetFirstVisibleItem()

Gets the first visible and selectable item in the collection.

Declaration

cs-api-definition
public RadItem GetFirstVisibleItem()

Returns

RadItem

The first visible and selectable RadItem, or null if none exists.

Implements IItemsControl.GetFirstVisibleItem()

GetLastVisibleItem()

Gets the last visible and selectable item in the collection.

Declaration

cs-api-definition
public RadItem GetLastVisibleItem()

Returns

RadItem

The last visible and selectable RadItem, or null if none exists.

Implements IItemsControl.GetLastVisibleItem()

GetNextItem(RadItem, bool)

Gets the next selectable item in the collection relative to the specified item.

Declaration

cs-api-definition
public RadItem GetNextItem(RadItem item, bool forward)

Parameters

item

RadItem

The reference item to navigate from, or null to get the first item.

forward

bool

True to navigate forward, false to navigate backward.

Returns

RadItem

The next selectable item, or null if no suitable item is found.

Implements IItemsControl.GetNextItem(RadItem, bool)

Remarks

If RollOverItemSelection is enabled, navigation will wrap around to the beginning/end when reaching the last/first item respectively.

GetSelectedItem()

Gets the currently selected item.

Declaration

cs-api-definition
public RadItem GetSelectedItem()

Returns

RadItem

The currently selected RadItem, or null if no item is selected.

Implements IItemsControl.GetSelectedItem()

SelectFirstVisibleItem()

Selects the first visible and selectable item in the collection.

Declaration

cs-api-definition
public RadItem SelectFirstVisibleItem()

Returns

RadItem

The selected RadItem, or null if no suitable item exists.

Implements IItemsControl.SelectFirstVisibleItem()

SelectItem(RadItem)

Selects the specified item and raises appropriate selection events.

Declaration

cs-api-definition
public void SelectItem(RadItem item)

Parameters

item

RadItem

The item to select.

Implements IItemsControl.SelectItem(RadItem)

Remarks

If a different item was previously selected, the ItemDeselected event is raised for the old item before selecting the new item and raising the ItemSelected event.

SelectLastVisibleItem()

Selects the last visible and selectable item in the collection.

Declaration

cs-api-definition
public RadItem SelectLastVisibleItem()

Returns

RadItem

The selected RadItem, or null if no suitable item exists.

Implements IItemsControl.SelectLastVisibleItem()

SelectNextItem(RadItem, bool)

Selects the next item in the specified direction relative to the current item.

Declaration

cs-api-definition
public RadItem SelectNextItem(RadItem item, bool forward)

Parameters

item

RadItem

The current item to navigate from.

forward

bool

True to select the next item, false to select the previous item.

Returns

RadItem

The newly selected item, or null if no suitable item was found.

Implements IItemsControl.SelectNextItem(RadItem, bool)

Events

ItemDeselected

Occurs when an item is deselected.

Declaration

cs-api-definition
public event ItemSelectedEventHandler ItemDeselected

Event Value

ItemSelectedEventHandler

Implements IItemsControl.ItemDeselected

ItemSelected

Occurs when an item is selected.

Declaration

cs-api-definition
public event ItemSelectedEventHandler ItemSelected

Event Value

ItemSelectedEventHandler

Implements IItemsControl.ItemSelected