BaseImageListBoxControl Class

Serves as a base for ImageListBoxControl class.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v21.1.dll

Declaration

public abstract class BaseImageListBoxControl :
    BaseListBoxControl

Remarks

This class is abstract and thus cannot be used directly. It inherits properties and methods from the BaseListBoxControl class which are common for all list box controls. It also introduces specific properties and methods peculiar only to image list box controls. The BaseImageListBoxControl.ImageList property represents the ImageList object containing images displayed next to items. The BaseImageListBoxControl.Items property enables you to access the collection of items represented by the ImageListBoxItemCollection class.

The ImageListBoxControl can be data bound using the BaseListBoxControl.DataSource property. The BaseImageListBoxControl.ImageIndexMember property represents the name of the proper data source field whose contents represent indexes of the images displayed within the items.

If you need to obtain the index of the image displayed next to a specific item, use the BaseImageListBoxControl.GetItemImageIndex method.

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.

See Also