Skip to main content

BaseButton Class

Serves as a base for button controls.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v22.1.dll

Declaration

public class BaseButton :
    BaseStyleControl,
    IButtonControl,
    ISupportCommandBinding,
    ISupportToolTipsForm

Remarks

The BaseButton class implements the basic functionality of a regular button. It is derived from the BaseStyleControl class, so it enables you to control the button’s appearance using the BaseControl.LookAndFeel, BaseButton.BorderStyle, and BaseStyleControl.Appearance properties. You can therefore use a common means to specify styles and look and feel for button controls derived from the BaseButton class, and other DevExpress controls.

The BaseButton class implements an IButtonControl interface. Members of this interface allow you to use the button as a dialog button (BaseButton.DialogResult) or as the default button (BaseButton.NotifyDefault).

Do not create instances of the BaseButton class in applications. Instead, use the derived SimpleButton control. The descendant introduces additional functionality, allowing you to display images within buttons.

Tooltips

DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers over 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.

    image

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

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

Use the SuperTip property to assign a super tooltip to a control. 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 the following topic for more information: Tooltips.

See Also