BaseListBoxControl Class

Serves as the base for ListBoxControl, BaseCheckedListBoxControl, CheckedListBoxControl, BaseImageListBoxControl and ImageListBoxControl classes.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public abstract class BaseListBoxControl :
    BaseStyleControl,
    IDXFocusController,
    ISupportInitialize,
    IDataInfo,
    IGestureClient,
    IMouseWheelSupport,
    IContextItemCollectionOwner,
    IContextItemCollectionOptionsOwner,
    IContextItemProvider,
    ISearchControlClient,
    ISupportItemTemplate,
    IControlRowSource,
    IScrollBarOwner

VB.NET

Public MustInherit Class BaseListBoxControl
    Inherits BaseStyleControl
    Implements IDXFocusController,
               ISupportInitialize,
               IDataInfo,
               IGestureClient,
               IMouseWheelSupport,
               IContextItemCollectionOwner,
               IContextItemCollectionOptionsOwner,
               IContextItemProvider,
               ISearchControlClient,
               ISupportItemTemplate,
               IControlRowSource,
               IScrollBarOwner

Remarks

This class is abstract and thus cannot be used directly. It implements basic list box control functionality and defines the properties, methods and events common to all list box controls (ListBoxControl, ImageListBoxControl and CheckedListBoxControl).

Tooltips

DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers the control.

Use the following properties to specify a regular tooltip’s content:

• ToolTip — a regular tooltip’s text. If the text is not specified, the tooltip is not displayed even if the title is specified. You can use line breaks in regular tooltips. Use the AllowHtmlTextInToolTip property to specify whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.
• ToolTipTitle — a regular tooltip’s title. If the title is not specified, it is not displayed.

• ToolTipIconType — a regular tooltip’s predefined icon. Use the controller’s IconSize property to specify the image size.

  

  To display a custom image in all regular tooltips, use the controller’s ImageList and ImageIndex properties.

  To display a custom image in a particular regular tooltip, handle the BeforeShow event. Use the ImageOptions event argument to assign a raster or vector image to the processed tooltip.

To assign a super tooltip to a control, use the SuperTip property. Enable the AllowHtmlText property to use HTML tags in the super tooltip.

To replace regular tooltips with super tooltips, set the ToolTipController.ToolTipType property to SuperTip. The controller automatically converts regular tooltips to super tooltips. To access this property, you can use the DefaultToolTipController component or a custom controller assigned to the ToolTipController property. See Tooltips for more information.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the BaseListBoxControl class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

listboxcontrol-how-to-customize-margins-of-items-t166302/CS/WindowsFormsApplication313/Form1.cs#L34

class CustomListBoxViewInfo : BaseListBoxViewInfo {
    public CustomListBoxViewInfo(BaseListBoxControl owner)
        : base(owner) {

VB.NET

listboxcontrol-how-to-customize-margins-of-items-t166302/VB/WindowsFormsApplication313/Form1.vb#L40

Public Sub New(ByVal owner As BaseListBoxControl)
    MyBase.New(owner)

Implements

IXtraResizableControl

Inheritance

Show 14 items

Object

MarshalByRefObject

Component

Control

ControlBase

BaseControl

BaseStyleControl

BaseListBoxControl

BaseCheckedListBoxControl

BaseImageListBoxControl

ListBoxControl

CheckedListBoxControl

ImageListBoxControl

ResourcesCheckedListBoxControl