WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SuperToolTip

    Show / Hide Table of Contents

    Class SuperToolTip

    Inheritance
    System.Object
    BaseComponent
    SuperToolTip
    Implements
    IThemeProvider
    IVisualStyle
    System.IDisposable
    System.ComponentModel.IExtenderProvider
    INativeMessageFilter
    System.Windows.Forms.IMessageFilter
    Inherited Members
    BaseComponent.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    BaseComponent.GetActiveThemeName()
    BaseComponent.OnCanApplyThemeChanged(Boolean)
    BaseComponent.OnCanOverrideStyleChanged(Boolean)
    BaseComponent.ThemeName
    BaseComponent.CanOverrideStyle
    BaseComponent.IThemeProvider.BaseThemeName
    BaseComponent.CanApplyTheme
    BaseComponent.ControlName
    BaseComponent.IVisualStyle.VisualTheme
    BaseComponent.IsVisualStyleEnabled
    BaseComponent.ThemeNameChanged
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class SuperToolTip : BaseComponent, IThemeProvider, IVisualStyle, IDisposable, IExtenderProvider, INativeMessageFilter, IMessageFilter

    Constructors

    SuperToolTip()

    Declaration
    public SuperToolTip()

    SuperToolTip(Control)

    Declaration
    public SuperToolTip(Control owner)
    Parameters
    Type Name Description
    System.Windows.Forms.Control owner

    Properties

    Active

    Declaration
    public bool Active { get; }
    Property Value
    Type Description
    System.Boolean

    GradientBackGround

    Declaration
    public bool GradientBackGround { get; set; }
    Property Value
    Type Description
    System.Boolean

    InitialDelay

    Declaration
    public int InitialDelay { get; set; }
    Property Value
    Type Description
    System.Int32

    MaxWidth

    Gets or sets the maximum width of SuperToolTip.

    Declaration
    public int MaxWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    MetroColor

    Gets or sets the theme color of the ButtonAdv

    Declaration
    public Color MetroColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    RightToLeft

    Declaration
    public RightToLeft RightToLeft { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.RightToLeft

    ShowAlways

    Declaration
    public bool ShowAlways { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowToolTip

    Gets or sets the value indicating whether to show or hide the SuperToolTip.

    Declaration
    public bool ShowToolTip { get; set; }
    Property Value
    Type Description
    System.Boolean

    Style

    Declaration
    public SuperToolTip.SuperToolTipStyle Style { get; set; }
    Property Value
    Type Description
    SuperToolTip.SuperToolTipStyle

    ThemeStyle

    Gets or sets the SuperToolTipVisualStyle value used to customize the appearance of the SuperToolTip.

    Declaration
    public SuperToolTipVisualStyle ThemeStyle { get; set; }
    Property Value
    Type Description
    SuperToolTipVisualStyle
    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    ToolTipDuration

    Gets or Sets, the duration of the ToolTip (in sec) when mouse hovers over a control.

    Declaration
    public int ToolTipDuration { get; set; }
    Property Value
    Type Description
    System.Int32

    UseFading

    Declaration
    public SuperToolTip.FadingType UseFading { get; set; }
    Property Value
    Type Description
    SuperToolTip.FadingType

    VisualStyle

    Gets or sets an advanced appearance for the SuperTooltip.

    Declaration
    public SuperToolTip.Appearance VisualStyle { get; set; }
    Property Value
    Type Description
    SuperToolTip.Appearance

    Methods

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    GetControlName(String)

    Helps to apply the ControlName settings in control

    Declaration
    public override string GetControlName(string controlName)
    Parameters
    Type Name Description
    System.String controlName
    Returns
    Type Description
    System.String
    Overrides
    BaseComponent.GetControlName(String)

    GetMenuButtonToolTip(RibbonControlAdv)

    Gets the tooltip from the MenuButton on RibbonControlAdv

    Declaration
    public ToolTipInfo GetMenuButtonToolTip(RibbonControlAdv ribbon)
    Parameters
    Type Name Description
    RibbonControlAdv ribbon

    The RibbonConrolAdv with MenuButton from which the tooltip should be get.

    Returns
    Type Description
    ToolTipInfo

    GetToolTip(Component)

    Gets SuperToolTip associated with a component.

    Declaration
    public ToolTipInfo GetToolTip(Component component)
    Parameters
    Type Name Description
    System.ComponentModel.Component component
    Returns
    Type Description
    ToolTipInfo

    Hide()

    Hides the tooltip.

    Declaration
    public void Hide()

    Hide(Component)

    Hides the tooltip using component.

    Declaration
    public void Hide(Component component)
    Parameters
    Type Name Description
    System.ComponentModel.Component component

    OnThemeNameChanged(String)

    Helps to apply the ThemeName settings in control

    Declaration
    public override void OnThemeNameChanged(string themeName)
    Parameters
    Type Name Description
    System.String themeName

    ThemeName

    Overrides
    BaseComponent.OnThemeNameChanged(String)

    SetMenuButtonToolTip(RibbonControlAdv, ToolTipInfo)

    Assigns the tooltip to a MenuButton instance on RibbonControlAdv.

    Declaration
    public void SetMenuButtonToolTip(RibbonControlAdv ribbon, ToolTipInfo value)
    Parameters
    Type Name Description
    RibbonControlAdv ribbon

    The RibbonConrolAdv with MenuButton to which the tooltip should be assigned.

    ToolTipInfo value

    The toolTipInfo created.

    SetToolTip(Component, ToolTipInfo)

    Sets SuperToolTip associated with a component.

    Declaration
    public void SetToolTip(Component component, ToolTipInfo value)
    Parameters
    Type Name Description
    System.ComponentModel.Component component

    The component to which the tooltip should be assigned.

    ToolTipInfo value

    The toolTipInfo created.

    Show(ToolTipInfo, Point)

    Shows the tooltip at a specified location.

    Declaration
    public void Show(ToolTipInfo ttInfo, Point position)
    Parameters
    Type Name Description
    ToolTipInfo ttInfo

    The ToolTipInfo created.

    System.Drawing.Point position

    The position to be displayed.

    Show(ToolTipInfo, Point, Int32)

    Shows the tooltip at a specified location for a particular amount of time.

    Declaration
    public void Show(ToolTipInfo ttInfo, Point position, int displayTime)
    Parameters
    Type Name Description
    ToolTipInfo ttInfo

    The ToolTipInfo created.

    System.Drawing.Point position

    The position to be displayed.

    System.Int32 displayTime

    Duration (in milliseconds) to display the ToolTip (-1 to display infinitely)

    Events

    PopupToolTip

    Occurs when the tool tip pops up.

    Declaration
    public event PopupToolTipHandler PopupToolTip
    Event Type
    Type Description
    PopupToolTipHandler

    UpdateToolTip

    Occurs when the tool tip is updated.

    Declaration
    public event UpdateToolTipHandler UpdateToolTip
    Event Type
    Type Description
    UpdateToolTipHandler

    Explicit Interface Implementations

    INativeMessageFilter.ProcessMessage(ref Message)

    Declaration
    bool INativeMessageFilter.ProcessMessage(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m
    Returns
    Type Description
    System.Boolean

    Implements

    IThemeProvider
    IVisualStyle
    System.IDisposable
    System.ComponentModel.IExtenderProvider
    INativeMessageFilter
    System.Windows.Forms.IMessageFilter
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved