Class RadDomainUpDownElement

Represents the main element that provides domain up-down functionality by combining text editing with up/down navigation buttons. This element extends RadDropDownListElement to provide a specialized interface for navigating through a predefined collection of items using directional buttons instead of a traditional dropdown list.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadEditorElement
EditorBaseElement
PopupEditorBaseElement
PopupEditorElement
RadDropDownListElement
RadDomainUpDownElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadDomainUpDownElement : RadDropDownListElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IInputEditor, IValueEditor, ISupportInitialize

Constructors

RadDomainUpDownElement()

Declaration
public RadDomainUpDownElement()

Properties

ArrowButton

This property is not relevant for this class.

Declaration
public override RadArrowButtonElement ArrowButton { get; }
Property Value
RadArrowButtonElement

Overrides

ArrowButtonMinWidth

This property is not relevant for this class.

Declaration
public override int ArrowButtonMinWidth { get; set; }
Property Value
System.Int32

Overrides

AutoComplete

Gets or sets a value indicating whether auto-complete is enabled. When enabled, the matched item's text will be appended to the input in the editor as the user types.

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

AutoCompleteDataSource

This property is not relevant for this class.

Declaration
public override object AutoCompleteDataSource { get; set; }
Property Value
System.Object

Overrides

AutoCompleteDisplayMember

This property is not relevant for this class.

Declaration
public override string AutoCompleteDisplayMember { get; set; }
Property Value
System.String

Overrides

AutoCompleteHelpers

This property is not relevant for this class.

Declaration
public override List<BaseAutoComplete> AutoCompleteHelpers { get; }
Property Value
System.Collections.Generic.List<BaseAutoComplete>

Overrides

AutoCompleteMode

This property is not relevant for this class.

Declaration
public override AutoCompleteMode AutoCompleteMode { get; set; }
Property Value
System.Windows.Forms.AutoCompleteMode

Overrides

AutoCompleteSuggest

This property is not relevant for this class.

Declaration
public override AutoCompleteSuggestHelper AutoCompleteSuggest { get; set; }
Property Value
AutoCompleteSuggestHelper

Overrides

AutoCompleteValueMember

This property is not relevant for this class.

Declaration
public override string AutoCompleteValueMember { get; set; }
Property Value
System.String

Overrides

AutoSize

This property is not relevant for this class.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

AutoSizeItems

This property is not relevant for this class.

Declaration
public override bool AutoSizeItems { get; set; }
Property Value
System.Boolean

Overrides

DefaultItemsCountInDropDown

This property is not relevant for this class.

Declaration
public override int DefaultItemsCountInDropDown { get; set; }
Property Value
System.Int32

Overrides

DownButtonElement

Gets the element representing the down navigation button. This button allows users to move to the next item in the collection.

Declaration
public RadRepeatArrowElement DownButtonElement { get; }
Property Value
RadRepeatArrowElement

DropDownAnimationEasing

This property is not relevant for this class.

Declaration
public override RadEasingType DropDownAnimationEasing { get; set; }
Property Value
RadEasingType

Overrides

DropDownAnimationEnabled

This property is not relevant for this class.

Declaration
public override bool DropDownAnimationEnabled { get; set; }
Property Value
System.Boolean

Overrides

DropDownAnimationFrames

This property is not relevant for this class.

Declaration
public override int DropDownAnimationFrames { get; set; }
Property Value
System.Int32

Overrides

DropDownHeight

This property is not relevant for this class.

Declaration
public override int DropDownHeight { get; set; }
Property Value
System.Int32

Overrides

DropDownMaxSize

This property is not relevant for this class.

Declaration
public override Size DropDownMaxSize { get; set; }
Property Value
System.Drawing.Size

Overrides

DropDownMinSize

This property is not relevant for this class.

Declaration
public override Size DropDownMinSize { get; set; }
Property Value
System.Drawing.Size

Overrides

DropDownSizingMode

This property is not relevant for this class.

Declaration
public override SizingMode DropDownSizingMode { get; set; }
Property Value
SizingMode

Overrides

DropDownStyle

This property is not relevant for this class.

Declaration
public override RadDropDownStyle DropDownStyle { get; set; }
Property Value
RadDropDownStyle

Overrides

DropDownWidth

This property is not relevant for this class.

Declaration
public override int DropDownWidth { get; set; }
Property Value
System.Int32

Overrides

FormatInfo

This property is not relevant for this class.

Declaration
public override IFormatProvider FormatInfo { get; set; }
Property Value
System.IFormatProvider

Overrides

FormatString

This property is not relevant for this class.

Declaration
public override string FormatString { get; set; }
Property Value
System.String

Overrides

FormattingEnabled

This property is not relevant for this class.

Declaration
public override bool FormattingEnabled { get; set; }
Property Value
System.Boolean

Overrides

IsPopupOpen

This property is not relevant for this class.

Declaration
public override bool IsPopupOpen { get; }
Property Value
System.Boolean

Overrides

IsPopupVisible

This property is not relevant for this class.

Declaration
public override bool IsPopupVisible { get; }
Property Value
System.Boolean

Overrides

MaxDropDownItems

This property is not relevant for this class.

Declaration
public override int MaxDropDownItems { get; set; }
Property Value
System.Int32

Overrides

Popup

This property is not relevant for this class.

Declaration
public override RadEditorPopupControlBase Popup { get; }
Property Value
RadEditorPopupControlBase

Overrides

ReadOnly

Gets or sets a value indicating whether typing is enabled inside the text box. When set to true, the control becomes read-only and users can only navigate using the up/down buttons or keyboard.

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

SortStyle

This property is not relevant for this class.

Declaration
public override SortStyle SortStyle { get; set; }
Property Value
SortStyle

Overrides

UpButtonElement

Gets the element representing the up navigation button. This button allows users to move to the previous item in the collection.

Declaration
public RadRepeatArrowElement UpButtonElement { get; }
Property Value
RadRepeatArrowElement

Wrap

Gets or sets a value indicating whether the selected item will revert to the first item after reaching the last item and vice versa. When enabled, navigation wraps around the collection boundaries to provide continuous circular navigation.

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

Methods

CanCreateArrowButtonElement()

Determines whether an arrow button element should be created for the dropdown functionality. For domain up-down controls, this returns false since navigation is handled by the dedicated up/down buttons.

Declaration
protected override bool CanCreateArrowButtonElement()
Returns
System.Boolean

Always returns false to prevent creation of the standard dropdown arrow button.
Overrides

ClosePopup()

This method is not relevant for this class.

Declaration
public override void ClosePopup()
Overrides

ClosePopup(RadPopupCloseReason)

This method is not relevant for this class.

Declaration
public override void ClosePopup(RadPopupCloseReason reason)
Parameters
RadPopupCloseReason reason

The reason for closing the popup.
Overrides

CreateChildElements()

Creates the visual elements that make up the RadDomainUpDownElement. This method initializes the button layout container, creates up and down navigation buttons, and configures the overall element structure for the domain up-down control.

Declaration
protected override void CreateChildElements()
Overrides

CreateDownButton()

Creates the down navigation button element that allows users to move to the next item in the collection. This method can be overridden in derived classes to provide custom down button implementations.

Declaration
protected virtual RadRepeatArrowElement CreateDownButton()
Returns
RadRepeatArrowElement

A RadRepeatArrowElement configured as a down button for downward navigation.

CreateElementsContainer()

Creates the container element that holds all child elements of the domain up-down control. This method establishes the main layout structure for organizing the text editor and navigation buttons.

Declaration
protected override StackLayoutElement CreateElementsContainer()
Returns
StackLayoutElement

A StackLayoutElement that serves as the main container for the domain up-down elements.
Overrides

CreateUpButton()

Creates the up navigation button element that allows users to move to the previous item in the collection. This method can be overridden in derived classes to provide custom up button implementations.

Declaration
protected virtual RadRepeatArrowElement CreateUpButton()
Returns
RadRepeatArrowElement

A RadRepeatArrowElement configured as an up button for upward navigation.

GetDesiredPopupSize()

This method is not relevant for this class.

Declaration
public override Size GetDesiredPopupSize()
Returns
System.Drawing.Size

The desired popup size.
Overrides

HandleOnKeyUpKeyDownPress(KeyEventArgs)

Handles keyboard navigation when Up or Down arrow keys are pressed. This method provides keyboard support for navigating through items using arrow keys with proper wrap behavior.

Declaration
protected override void HandleOnKeyUpKeyDownPress(KeyEventArgs keyEventArgs)
Parameters
System.Windows.Forms.KeyEventArgs keyEventArgs

The key event arguments containing information about the pressed key.
Overrides

MoveDown(Boolean)

Selects the next item in the list, optionally wrapping to the first item if at the end. This method handles downward navigation through the item collection with proper boundary checking.

Declaration
public virtual void MoveDown(bool wrap)
Parameters
System.Boolean wrap

Specifies whether the navigation will wrap from the last item to the first item when at the end of the collection.

MoveUp(Boolean)

Selects the previous item in the list, optionally wrapping to the last item if at the beginning. This method handles upward navigation through the item collection with proper boundary checking.

Declaration
public virtual void MoveUp(bool wrap)
Parameters
System.Boolean wrap

Specifies whether the navigation will wrap from the first item to the last item when at the beginning of the collection.

OnDownButtonClick(Object, EventArgs)

Handles the click event of the down button to navigate to the next item. This method is called when the user clicks the down arrow button and triggers downward navigation with the current wrap setting.

Declaration
protected virtual void OnDownButtonClick(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event, typically the down button element.
System.EventArgs e

The event data.

OnMouseWheelCore(MouseEventArgs)

Handles mouse wheel events to provide scrolling navigation through items. This method enables users to navigate through the item collection using the mouse wheel with proper wrap behavior.

Declaration
protected override void OnMouseWheelCore(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The mouse event arguments containing information about the mouse wheel movement.
Overrides

OnUpButtonClick(Object, EventArgs)

Handles the click event of the up button to navigate to the previous item. This method is called when the user clicks the up arrow button and triggers upward navigation with the current wrap setting.

Declaration
protected virtual void OnUpButtonClick(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event, typically the up button element.
System.EventArgs e

The event data.

ShowPopup()

This method is not relevant for this class.

Declaration
public override void ShowPopup()
Overrides

TooglePopupState()

Overrides the base toggle popup functionality to prevent popup display. In domain up-down controls, popup functionality is disabled since navigation is handled through the up/down buttons.

Declaration
protected override void TooglePopupState()
Overrides

UnwireEvents()

Detaches event handlers from the up and down button elements during cleanup. This method ensures proper resource cleanup and prevents memory leaks by removing event subscriptions.

Declaration
protected override void UnwireEvents()
Overrides

Events

PopupClosed

This event is not relevant for this class.

Declaration
public override event RadPopupClosedEventHandler PopupClosed
Event Type
RadPopupClosedEventHandler

Overrides

PopupClosing

This event is not relevant for this class.

Declaration
public override event RadPopupClosingEventHandler PopupClosing
Event Type
RadPopupClosingEventHandler

Overrides

PopupOpened

This event is not relevant for this class.

Declaration
public override event EventHandler PopupOpened
Event Type
System.EventHandler

Overrides

PopupOpening

This event is not relevant for this class.

Declaration
public override event CancelEventHandler PopupOpening
Event Type
System.ComponentModel.CancelEventHandler

Overrides

Extension Methods