New to Telerik UI for WinForms? Start a free 30-day trial

Provides item selection, keyboard navigation, and drop-down lifecycle behavior for popup controls that host RadItem objects.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public abstract class RadItemsPopupControl : RadPopupControlBase, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, IPopupControl, IItemsControl

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadPopupControlBaseRadItemsPopupControl...

Derived Classes: RadDropDownMenu

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetIItemsControlILayoutHandlerINotifyPropertyChangedIPopupControlISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadPopupControlBase.lastAlignmentRectangleRadPopupControlBase.dpiScaleFactorRadPopupControlBase.AnimationPropertiesRadPopupControlBase.GetMonitorDpiScaleFactor(Control)RadPopupControlBase.Show()RadPopupControlBase.Show(Point)RadPopupControlBase.Show(Control)RadPopupControlBase.Hide()RadPopupControlBase.ProcessFocusRequested(RadElement)RadPopupControlBase.WndProc(ref Message)RadPopupControlBase.OnPopupOpened()RadPopupControlBase.OnPopupOpening(CancelEventArgs)RadPopupControlBase.OnPopupClosed(RadPopupClosedEventArgs)RadPopupControlBase.OnPopupClosing(RadPopupClosingEventArgs)RadPopupControlBase.InitializeDropDownAnimation(Point)RadPopupControlBase.GetBackupSize()RadPopupControlBase.UpdateAeroEffectState()RadPopupControlBase.UpdateLocation(Rectangle)RadPopupControlBase.UpdateLocation()RadPopupControlBase.GetCorrectedLocation(Rectangle)RadPopupControlBase.GetCorrectedLocation(Screen, Rectangle)RadPopupControlBase.GetCorrectedLocation(Screen, Rectangle, Size)RadPopupControlBase.ApplySizingConstraints(Size, Screen)RadPopupControlBase.GetCurrentScreen(Rectangle)RadPopupControlBase.GetCurrentScreen()RadPopupControlBase.GetAvailableBoundsFromScreen(Screen)RadPopupControlBase.GetCorrectedHorizontalLocation(Screen, Rectangle, Point)RadPopupControlBase.GetCorrectedHorizontalLocation(Screen, Rectangle, Point, Size)RadPopupControlBase.GetCorrectedVerticalLocation(Screen, Rectangle, Point)RadPopupControlBase.GetCorrectedVerticalLocation(Screen, Rectangle, Point, Size)RadPopupControlBase.GetHorizontalPopupLocation(Rectangle)RadPopupControlBase.GetVerticalPopupLocation(Rectangle)RadPopupControlBase.AnimationStarting()RadPopupControlBase.OnAlternativeXLocationNeeded(Rectangle, Point, Rectangle)RadPopupControlBase.CheckMakeLastLocationCorrection(Rectangle, Point, Rectangle)RadPopupControlBase.CheckMakeLastLocationCorrection(Rectangle, Point, Rectangle, Size)RadPopupControlBase.OnAlternativeYLocationNeeded(Rectangle, Point, Rectangle)RadPopupControlBase.ShowPopupCore(Size, Point)RadPopupControlBase.ShowPopup(Rectangle)RadPopupControlBase.ClosePopup(PopupCloseInfo)RadPopupControlBase.OnPopupClosing(PopupCloseInfo)RadPopupControlBase.OnPopupClosed(PopupCloseInfo)RadPopupControlBase.ClosePopup(RadPopupCloseReason)RadPopupControlBase.CanClosePopup(RadPopupCloseReason)RadPopupControlBase.OnKeyDown(Keys)RadPopupControlBase.OnMouseWheel(Control, int)RadPopupControlBase.CallMouseWheel(MouseEventArgs)RadPopupControlBase.OnAnimationFinished(AnimationEventArgs)RadPopupControlBase.OnAnimating(AnimationEventArgs)RadPopupControlBase.ShouldRestoreAutoSizeRadPopupControlBase.DropDownAnimationDirectionRadPopupControlBase.EasingTypeRadPopupControlBase.AnimationFramesRadPopupControlBase.AnimationEnabledRadPopupControlBase.AnimationTypeRadPopupControlBase.NonAnimatedSizeRadPopupControlBase.FadeAnimationFramesRadPopupControlBase.FadeAnimationSpeedRadPopupControlBase.OpacityRadPopupControlBase.DropShadowRadPopupControlBase.EnableAeroEffectsRadPopupControlBase.FadeAnimationTypeRadPopupControlBase.FitToScreenModeRadPopupControlBase.ScreenSpaceModeRadPopupControlBase.AlignmentRectangleOverlapModeRadPopupControlBase.HorizontalAlignmentCorrectionModeRadPopupControlBase.VerticalAlignmentCorrectionModeRadPopupControlBase.VerticalPopupAlignmentRadPopupControlBase.HorizontalPopupAlignmentRadPopupControlBase.CreateParamsRadPopupControlBase.OwnerElementRadPopupControlBase.OwnerPopupRadPopupControlBase.LastShowDpiScaleFactorRadPopupControlBase.WindowsSettingsRadPopupControlBase.ChildrenRadPopupControlBase.MouseWheelRadPopupControlBase.FadeAnimationFinishedRadPopupControlBase.PopupOpeningRadPopupControlBase.PopupOpenedRadPopupControlBase.PopupClosingRadPopupControlBase.PopupClosedRadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.CreateChildItems(RadElement)RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseDown(MouseEventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseMove(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.OnInvalidated(RadElement)RadControl.OnLoad(Size)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.ProcessAutoSizeChanged(bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.GetPreferredSize(Size)RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ThemeClassNameRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.FontRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

Initializes the popup with the element that owns and anchors it.

C#
public RadItemsPopupControl(RadElement owner)
Parameters:ownerRadElement

The element that owns the popup.

Properties

Gets the collection used by this popup's selection and navigation logic; it is the same collection as Items.

C#
public RadItemOwnerCollection ActiveItems { get; }

Implements: IItemsControl.ActiveItems

Gets a boolean value indicating whether the popup is visible.

C#
public bool IsVisible { get; }

Gets menu items collection

C#
[Browsable(true)]
public RadItemOwnerCollection Items { get; }

Implements: IItemsControl.Items

Get/Set maximum value allowed for size

C#
public Size Maximum { get; set; }

Get/Set minimum value allowed for size

C#
public Size Minimum { get; set; }

Gets or sets whether this popup's item-control implementation processes keyboard input.

C#
public bool ProcessKeyboard { get; set; }

Implements: IItemsControl.ProcessKeyboard

Gets or sets whether item navigation wraps between the last and first selectable items.

C#
public bool RollOverItemSelection { get; set; }

Implements: IItemsControl.RollOverItemSelection

Methods

Resets the popup's size constraints to its current width and size.

C#
protected void AutoUpdateBounds()

Forwards a deselection notification to the overridable OnItemDeselected(ItemSelectedEventArgs) hook.

C#
public void CallOnItemDeselected(ItemSelectedEventArgs args)
Parameters:argsItemSelectedEventArgs

The item-selection event data.

Determines whether this popup supports navigation with the supplied key. The shared implementation returns false; subclasses can provide navigation handling.

C#
public virtual bool CanNavigate(Keys keyData)
Parameters:keyDataKeys

The key to check.

Returns:

bool

false in this implementation.

Implements: IItemsControl.CanNavigate(Keys)

Determines whether this popup processes the supplied mnemonic character. The shared implementation returns false; subclasses can provide mnemonic handling.

C#
public virtual bool CanProcessMnemonic(char keyData)
Parameters:keyDatachar

The mnemonic character to check.

Returns:

bool

false in this implementation.

Implements: IItemsControl.CanProcessMnemonic(char)

Clears the active popup handle before delegating resource disposal to the base class.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

Overrides: RadPopupControlBase.Dispose(bool)

Gets the first item that is both visible and selectable.

C#
public RadItem GetFirstVisibleItem()
Returns:

RadItem

The first eligible item, or null if none exists.

Implements: IItemsControl.GetFirstVisibleItem()

Gets the last item that is both visible and selectable.

C#
public RadItem GetLastVisibleItem()
Returns:

RadItem

The last eligible item, or null if none exists.

Implements: IItemsControl.GetLastVisibleItem()

Gets the next visible, selectable item relative to item. Navigation can wrap around when RollOverItemSelection is enabled.

C#
public RadItem GetNextItem(RadItem item, bool forward)
Parameters:itemRadItem

The item to navigate from, or null to find the first item.

forwardbool

true to search forward; otherwise, search backward.

Returns:

RadItem

The next eligible item, or null if none is found.

Implements: IItemsControl.GetNextItem(RadItem, bool)

Gets the currently selected item, or null if no item is selected.

C#
public RadItem GetSelectedItem()
Returns:

RadItem

The selected item.

Implements: IItemsControl.GetSelectedItem()

Raises DropDownClosed after the popup closes.

C#
protected virtual void OnDropDownClosed(RadPopupClosedEventArgs args)
Parameters:argsRadPopupClosedEventArgs

Information about the popup-closing operation.

Raises DropDownClosing before the popup closes.

C#
protected virtual void OnDropDownClosing(RadPopupClosingEventArgs args)
Parameters:argsRadPopupClosingEventArgs

Information about the popup-closing operation.

Raises DropDownOpened after the popup opens.

C#
protected virtual void OnDropDownOpened()

Raises DropDownOpening and allows handlers to cancel the opening operation.

C#
protected virtual void OnDropDownOpening(CancelEventArgs args)
Parameters:argsCancelEventArgs

The event data whose Cancel value can prevent opening.

Runs after the ItemDeselected event is raised, allowing subclasses to respond to item deselection.

C#
protected virtual void OnItemDeselected(ItemSelectedEventArgs args)
Parameters:argsItemSelectedEventArgs

The item-selection event data.

Runs after the ItemSelected event is raised, allowing subclasses to respond to item selection.

C#
protected virtual void OnItemSelected(ItemSelectedEventArgs args)
Parameters:argsItemSelectedEventArgs

The item-selection event data.

Selects the first item that is both visible and selectable.

C#
public RadItem SelectFirstVisibleItem()
Returns:

RadItem

The selected item, or null if none exists.

Implements: IItemsControl.SelectFirstVisibleItem()

Selects an item, raising ItemDeselected for a different previously selected item before ItemSelected for the new item.

C#
public void SelectItem(RadItem item)
Parameters:itemRadItem

The item to select.

Implements: IItemsControl.SelectItem(RadItem)

Selects the last item that is both visible and selectable.

C#
public RadItem SelectLastVisibleItem()
Returns:

RadItem

The selected item, or null if none exists.

Implements: IItemsControl.SelectLastVisibleItem()

Selects the next visible, selectable item relative to item.

C#
public RadItem SelectNextItem(RadItem item, bool forward)
Parameters:itemRadItem

The item to navigate from.

forwardbool

true to search forward; otherwise, search backward.

Returns:

RadItem

The newly selected item, or null if none is found.

Implements: IItemsControl.SelectNextItem(RadItem, bool)

Events

Occurs after the popup has closed.

C#
public event RadPopupClosedEventHandler DropDownClosed

Occurs before the popup closes.

C#
public event RadPopupClosingEventHandler DropDownClosing

Occurs after the popup has opened.

C#
public event EventHandler DropDownOpened

Occurs before the popup opens; the event handler can cancel the opening operation.

C#
public event CancelEventHandler DropDownOpening

Occurs when the popup's item-selection logic deselects an item.

C#
public event ItemSelectedEventHandler ItemDeselected

Implements: IItemsControl.ItemDeselected

Occurs when the popup's item-selection logic selects an item.

C#
public event ItemSelectedEventHandler ItemSelected

Implements: IItemsControl.ItemSelected