Class

RadListControl

Initializes a new instance of the RadListControl class with default settings.

Declaration

public RadListControl()

Declaration

public static readonly object CreatingVisualListItemEventKey

Field Value

Declaration

public static readonly object ListItemDataBindingEventKey

Field Value

Declaration

public static readonly object ListItemDataBoundEventKey

Field Value

Declaration

public static readonly object SelectedIndexChangedEventKey

Field Value

Declaration

public static readonly object SelectedIndexChangingEventKey

Field Value

Declaration

public static readonly object SelectedValueChangedEventKey

Field Value

Declaration

public static readonly object SortStyleChangedEventKey

Field Value

Declaration

public static readonly object VisualItemFormattingEventKey

Field Value

Gets or sets the active item that receives focus for keyboard navigation in multi-selection modes.

Declaration

[Browsable(false)]
public RadListDataItem ActiveItem { get; set; }

Property Value

Gets or sets a value indicating whether users can reorder items using drag and drop operations.

Declaration

[Browsable(true)]
public bool AllowDragDrop { get; set; }

Property Value

Gets or sets a value that indicates whether items will be sized according to their content. If this property is true the user can set the Height property of each individual RadListDataItem in the Items collection in order to override the automatic sizing.

Declaration

[Browsable(true)]
public bool AutoSizeItems { get; set; }

Property Value

Gets or sets a value indicating whether text case sensitivity is considered during sorting operations.

Declaration

[Browsable(true)]
public bool CaseSensitiveSort { get; set; }

Property Value

Gets or sets the name of the data member to bind to when the DataSource contains multiple tables or lists.

Declaration

[Browsable(true)]
public string DataMember { get; set; }

Property Value

Gets or sets the data source that provides the items to be displayed in the RadListControl.

Declaration

[Browsable(true)]
public object DataSource { get; set; }

Property Value

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets the property name used to extract description text from data items for additional item information display.

Declaration

[Browsable(true)]
public string DescriptionTextMember { get; set; }

Property Value

Gets or sets the property name used to extract display text from data items for visual representation in the list.

Declaration

[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
[Browsable(true)]
public string DisplayMember { get; set; }

Property Value

Gets or sets a value indicating whether alternating background colors are applied to list items for improved readability.

Declaration

[Browsable(true)]
public virtual bool EnableAlternatingItemColor { get; set; }

Property Value

Gets or sets a value indicating whether kinetic scrolling is enabled for smooth touch-based scrolling interactions.

Declaration

[Browsable(true)]
public bool EnableKineticScrolling { get; set; }

Property Value

Gets or sets a value indicating whether the UI Automation functionality is enabled.

Declaration

public override bool EnableUIAutomation { get; set; }

Property Value

Overrides RadControl.EnableUIAutomation

Implements ISupportRootUIAutomation.EnableUIAutomation

Gets or sets a predicate which filters which items can be visible.

Declaration

[Browsable(false)]
public Predicate<RadListDataItem> Filter { get; set; }

Property Value

Gets or sets a filter expression string that determines which items are visible in the list based on the specified criteria.

Declaration

[Browsable(true)]
public string FilterExpression { get; set; }

Property Value

Gets or sets an implementation of IFindStringComparer used for customizing string comparison behavior in the FindString method.

Declaration

[Browsable(false)]
public IFindStringComparer FindStringComparer { get; set; }

Property Value

Gets or sets a value indicating whether items are automatically resized to fit the control's width.

Declaration

public bool FitItemsToSize { get; set; }

Property Value

Gets or sets a format string which will be used for visual formatting of the items text.

Declaration

[Browsable(true)]
public string FormatString { get; set; }

Property Value

Gets or sets a value that indicates whether the FormatString and FormatInfo properties will be used to format the items text. Setting this property to false may improve performance.

Declaration

[Browsable(true)]
public bool FormattingEnabled { get; set; }

Property Value

Gets a value indicating whether any filtering is currently active, either through a Filter delegate or FilterExpression.

Declaration

[Browsable(false)]
public bool IsFilterActive { get; }

Property Value

Gets or sets the height of individual list items in pixels.

Declaration

[Browsable(true)]
public int ItemHeight { get; set; }

Property Value

Gets or sets the text comparison mode that determines whether the FindString method searches using user-specified text or data-bound text from the DisplayMember.

Declaration

[Browsable(false)]
public ItemTextComparisonMode ItemTextComparisonMode { get; set; }

Property Value

Gets the collection of data items contained in the RadListControl. Items cannot be modified in data bound mode.

Declaration

[Browsable(true)]
public RadListDataItemCollection Items { get; }

Property Value

Gets or sets a value indicating whether users can search for items by typing characters while the RadListControl has focus.

Declaration

[Browsable(true)]
public bool KeyboardSearchEnabled { get; set; }

Property Value

Gets or sets the time interval in milliseconds that the user must wait before the keyboard search functionality is reset.

Declaration

[Browsable(true)]
public int KeyboardSearchResetInterval { get; set; }

Property Value

Gets the main element that provides the list functionality and serves as the core component of the RadListControl.

Declaration

[Browsable(false)]
public RadListElement ListElement { get; set; }

Property Value

Gets or set the scroll mode.

Declaration

[Browsable(true)]
public ItemScrollerScrollModes ScrollMode { get; set; }

Property Value

Gets or sets the currently selected index.

Declaration

[Browsable(false)]
public int SelectedIndex { get; set; }

Property Value

Gets or sets the currently selected item.

Declaration

[Browsable(false)]
[Bindable(true)]
public RadListDataItem SelectedItem { get; set; }

Property Value

Gets a read-only collection of the currently selected items in the RadListControl.

Declaration

[Browsable(false)]
public IReadOnlyCollection<RadListDataItem> SelectedItems { get; }

Property Value

Gets or sets the value of the currently selected item based on the ValueMember property.

Declaration

[Browsable(false)]
[Bindable(true)]
public object SelectedValue { get; set; }

Property Value

Gets or sets the selection mode that determines how items can be selected in the RadListControl.

Declaration

[Browsable(true)]
public SelectionMode SelectionMode { get; set; }

Property Value

Gets or sets the sorting behavior applied to the list items.

Declaration

[Browsable(true)]
public SortStyle SortStyle { get; set; }

Property Value

Gets or sets a value indicating whether the ItemsChanging and ItemsChanged events are temporarily suspended from firing.

Declaration

[Browsable(false)]
public bool SuspendItemsChangeEvents { get; set; }

Property Value

Gets or sets a value that determines whether to stop the selection events from firing. These are SelectedIndexChanged, SelectedIndexChanging and SelectedValueChanged.

Declaration

[Browsable(false)]
public bool SuspendSelectionEvents { get; set; }

Property Value

Gets or sets the property name used to extract values from data items, which will be accessible through the Value property of each RadListDataItem.

Declaration

[Browsable(true)]
public string ValueMember { get; set; }

Property Value

Suspends internal notifications and processing to improve performance during bulk operations. This method is cumulative, requiring matching calls to EndUpdate().

Declaration

public void BeginUpdate()

Determines whether an element may be edited via the EditUIElements dialog at design-time.

Declaration

protected override bool CanEditElementAtDesignTime(RadElement element)

Parameters

Returns

Overrides RadControl.CanEditElementAtDesignTime(RadElement)

Declaration

protected virtual void ClearMeasuredSize()

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the child elements for the RadListControl.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates and returns a new instance of the RadListElement that provides the core list functionality.

Declaration

protected virtual RadListElement CreateListElement()

Returns

Creates a disposable object that defers refresh operations until disposed, allowing multiple changes to be batched together.

Declaration

public virtual IDisposable DeferRefresh()

Returns

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Resumes layout.

Declaration

public override void EndInit()

Overrides RadControl.EndInit()

Resumes internal notifications and processing previously suspended by BeginUpdate().

Declaration

public void EndUpdate()

Declaration

public RadListDataItem FindItemExact(string text, bool caseSensitive)

Parameters

Returns

Searches for an item that matches the specified string using the configured FindStringComparer, starting from the beginning of the list.

Declaration

public int FindString(string s)

Parameters

Returns

Searches for an item that matches the specified string using the configured FindStringComparer, starting from the specified index.

Declaration

public int FindString(string s, int startIndex)

Parameters

Returns

Searches for an item with text that exactly matches the specified string, starting from the beginning of the list.

Declaration

public int FindStringExact(string s)

Parameters

Returns

Searches for an item with text that exactly matches the specified string, starting from the specified index.

Declaration

public int FindStringExact(string s, int startIndex)

Parameters

Returns

Searches for an item in the same manner as FindString() but does not start from the beginning when the end of the Items collection is reached.

Declaration

public int FindStringNonWrapping(string s)

Parameters

Returns

Searches for an item in the same manner as FindString() but does not start from the beginning when the end of the Items collection is reached.

Declaration

public int FindStringNonWrapping(string s, int startIndex)

Parameters

Returns

Declaration

protected virtual void HandleEndKey()

Declaration

protected virtual void HandleHomeKey()

Declaration

protected virtual void HandlePageDownKey()

Declaration

protected virtual void HandlePageUpKey()

Declaration

protected override bool IsInputChar(char charCode)

Parameters

Returns

Overrides Control.IsInputChar(char)

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Declaration

protected virtual void OnCreatingVisualItem(object sender, CreatingVisualListItemEventArgs args)

Parameters

Raises the DataBindingComplete event.

Declaration

protected virtual void OnDataBindingComplete(object sender, ListBindingCompleteEventArgs e)

Parameters

Declaration

protected override void OnEnabledChanged(EventArgs e)

Parameters

Overrides RadControl.OnEnabledChanged(EventArgs)

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides RadControl.OnGotFocus(EventArgs)

Declaration

protected virtual void OnItemDataBinding(object sender, ListItemDataBindingEventArgs args)

Parameters

Declaration

protected virtual void OnItemDataBound(object sender, ListItemDataBoundEventArgs args)

Parameters

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Notifies that the control is about to be visualized.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseMove(MouseEventArgs)

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseUp(MouseEventArgs)

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Declaration

protected virtual void OnSelectedIndexChanged(object sender, int newIndex)

Parameters

Declaration

protected virtual bool OnSelectedIndexChanging(object sender, int newIndex)

Parameters

Returns

Declaration

protected virtual void OnSelectedValueChanged(object sender, int newIndex, object newValue, object oldValue)

Parameters

Declaration

protected virtual void OnSortStyleChanged(object sender, SortStyleChangedEventArgs args)

Parameters

Declaration

protected virtual void OnVisualItemFormatting(object sender, VisualItemFormattingEventArgs args)

Parameters

Declaration

protected override void ProcessCodedUIMessage(ref IPCMessage request)

Parameters

Overrides RadControl.ProcessCodedUIMessage(ref IPCMessage)

Forces re-evaluation of the current data source (if any).

Declaration

public void Rebind()

Scrolls the view by the specified number of pages.

Declaration

public void ScrollByPage(int pageCount)

Parameters

Scrolls the view to make the specified item visible, positioning it appropriately within the visible area.

Declaration

public void ScrollToItem(RadListDataItem item)

Parameters

Selects all items in the list if the current SelectionMode allows multiple selection.

Declaration

public void SelectAll()

Exceptions

Clears current selection and selects all items within the specified index range.

Declaration

public void SelectRange(int startIndex, int endIndex)

Parameters

Unsubscribes from the relevant events of the underlying RadListElement.

Declaration

protected virtual void UnwireEvents()

Subscribes to the relevant events of the underlying RadListElement.

Declaration

protected virtual void WireEvents()

Declaration

protected override void WndProc(ref Message m)

Parameters

Overrides RadControl.WndProc(ref Message)

Occurs when custom visual items need to be created, allowing users to provide custom visual representations for list items.

Declaration

public event CreatingVisualListItemEventHandler CreatingVisualListItem

Event Value

Fires after data binding operation has finished.

Declaration

[Browsable(true)]
public event ListBindingCompleteEventHandler DataBindingComplete

Event Value

Occurs before a RadListDataItem is data bound, allowing customization of the data binding process and providing custom item instances.

Declaration

public event ListItemDataBindingEventHandler ItemDataBinding

Event Value

Occurs after a RadListDataItem has been data bound, providing an opportunity to modify the bound item.

Declaration

public event ListItemDataBoundEventHandler ItemDataBound

Event Value

This event fires when the selected index property changes.

Declaration

public event PositionChangedEventHandler SelectedIndexChanged

Event Value

This event fires before SelectedIndex changes. This event allows the operation to be cancelled.

Declaration

public event PositionChangingEventHandler SelectedIndexChanging

Event Value

Occurs when the SelectedItems collection changes due to selection modifications.

Declaration

public event NotifyCollectionChangedEventHandler SelectedItemsChanged

Event Value

This event fires before the SelectedItems collection changes.

Declaration

public event NotifyCollectionChangingEventHandler SelectedItemsChanging

Event Value

This event fires only if the SelectedValue has really changed. For example it will not fire if the previously selected item has the same value as the newly selected item.

Declaration

public event EventHandler SelectedValueChanged

Event Value

Occurs when the SortStyle property value changes.

Declaration

public event SortStyleChangedEventHandler SortStyleChanged

Event Value

Occurs when visual item formatting is needed, allowing customization of the appearance of visible list items.

Declaration

public event VisualListItemFormattingEventHandler VisualItemFormatting

Event Value