menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ToolTipAdv - API Reference

    Show / Hide Table of Contents

    Class ToolTipAdv

    This class represents the information to be displayed in the ToolTip.

    Inheritance
    System.Object
    PopupControlContainer
    ToolTipAdv
    Implements
    IPopupControlContainer
    IPopupChild
    INeedKeyboardMessages
    INeedMouseMoveMessages
    IMouseHookHLProcClient
    IKeyboardProcHookClient
    IPopupParent
    IPopupItem
    IThemeProvider
    IVisualStyle
    Inherited Members
    PopupControlContainer.EnsurePopupHost()
    PopupControlContainer.CreatePopupHost()
    PopupControlContainer.CreateAccessibilityInstance()
    PopupControlContainer.INeedMouseMoveMessages.MouseMessage(Message)
    PopupControlContainer.IMouseHookHLProcClient.MouseHookProc(Int32, Point, IntPtr, Int32, Int32)
    PopupControlContainer.ProcessMouseMessage(Control, Int32, IntPtr, IntPtr)
    PopupControlContainer.INeedKeyboardMessages.KeyboardMessage(Message)
    PopupControlContainer.IKeyboardProcHookClient.KeyboardHookProc(Int32, Int32)
    PopupControlContainer.VeryifyMouseBasedDeactivation(Control, Int32)
    PopupControlContainer.GetPreferredLocation(PopupRelativeAlignment, PopupRelativeAlignment)
    PopupControlContainer.ShowPopup(Point)
    PopupControlContainer.HidePopup()
    PopupControlContainer.ConfirmDeactivate()
    PopupControlContainer.HidePopup(PopupCloseType)
    PopupControlContainer.ProcessDialogKey(Keys)
    PopupControlContainer.WndProc(Message)
    PopupControlContainer.FocusParent()
    PopupControlContainer.FocusFirstVisibleParent()
    PopupControlContainer.IsInSetFocus()
    PopupControlContainer.ApplyScaleToControl(Single)
    PopupControlContainer.OnFontChanged(EventArgs)
    PopupControlContainer.OnSizeChanged(EventArgs)
    PopupControlContainer.GetLocationForPopupAlignment(PopupRelativeAlignment, PopupRelativeAlignment)
    PopupControlContainer.IPopupParent.GetLocationForPopupAlignment(PopupRelativeAlignment, PopupRelativeAlignment)
    PopupControlContainer.GetBorderOverlapCue(PopupRelativeAlignment)
    PopupControlContainer.IPopupParent.GetBorderOverlapCue(PopupRelativeAlignment)
    PopupControlContainer.ChildClosing(IPopupChild, PopupCloseType)
    PopupControlContainer.IPopupParent.ChildClosing(IPopupChild, PopupCloseType)
    PopupControlContainer.IPopupItem.GetPopupParentControl()
    PopupControlContainer.IsRelatedControl(Control, Boolean)
    PopupControlContainer.IsShowing()
    PopupControlContainer.OnCloseUp(PopupClosedEventArgs)
    PopupControlContainer.OnPopup(EventArgs)
    PopupControlContainer.DesignMode
    PopupControlContainer.DefaultSize
    PopupControlContainer.Font
    PopupControlContainer.DefaultMargin
    PopupControlContainer.FakeFocus
    PopupControlContainer.PopupHost
    PopupControlContainer.DiscreetLocation
    PopupControlContainer.ParentControl
    PopupControlContainer.PopupParent
    PopupControlContainer.IgnoreDialogKey
    PopupControlContainer.IgnoreMouseMessages
    PopupControlContainer.CloseOnTab
    PopupControlContainer.EnableTouchMode
    PopupControlContainer.IPopupParent.IsRightToLeft
    PopupControlContainer.CurrentPopupChild
    PopupControlContainer.BeforeCloseUp
    PopupControlContainer.CloseUp
    PopupControlContainer.BeforePopup
    PopupControlContainer.Popup
    Namespace: Syncfusion.Windows.Forms
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class ToolTipAdv : PopupControlContainer, IPopupControlContainer, IPopupChild, INeedKeyboardMessages, INeedMouseMoveMessages, IMouseHookHLProcClient, IKeyboardProcHookClient, IPopupParent, IPopupItem, IThemeProvider, IVisualStyle

    Constructors

    ToolTipAdv(Control)

    Declaration
    public ToolTipAdv(Control host)
    Parameters
    Type Name Description
    System.Windows.Forms.Control host

    Properties

    BackgroundColor

    The background color, gradient and other styles can be set through this property.

    Declaration
    public BrushInfo BackgroundColor { get; set; }
    Property Value
    Type Description
    BrushInfo
    Remarks

    The ToolTipAdv control provides this property to enable specialized custom gradient backgrounds.

    BaseThemeName

    Gets or sets the BaseTheme name of the theme

    Declaration
    public string BaseThemeName { get; set; }
    Property Value
    Type Description
    System.String

    Border3DStyle

    Gets / sets the style of the 3D border.

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

    BorderSingle

    Gets / sets the 2D border style.

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

    BorderStyle

    Gets / sets the border style of the panel.

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

    CanApplyTheme

    Gets or sets a value indicating whether a SkinManager theme style has been applied to the control.

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

    The default value is true.

    CanOverrideStyle

    Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

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

    Default value is false.

    Remarks

    By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

    IgnoreKeys

    Indicates whether to ignore all keys.

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

    True to ignore all keys; False otherwise. Default is False.

    Remarks

    When the popup is showing, it will "swallow" all the WM_KEYDOWN and WM_CHAR messages. To prevent it, set this property to True.

    InheritHostCursor

    Indicates if cursor of host control is used.

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

    IsVisualStyleEnabled

    Gets a value indicating whether the visual style based theme is applied to the control and also indicates whether the theme files are referred from external assemblies or not.

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

    Return true, if the visual style based theme is applied to the control. Otherwise returns false.

    RestrictWidth

    Gets or sets the maximum width of the tooltip control. It wraps text that flows beyond the restricted width.To allow text to flow in a single line, set restricted width to zero.

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

    Text

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    ThemeName

    Gets or sets the theme name of the ToolTipAdv control.

    Declaration
    public string ThemeName { get; set; }
    Property Value
    Type Description
    System.String

    ThemeStyle

    Gets or sets the ToolTipAdvVisualStyle value used to customize the appearance of the ToolTipAdv.

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

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

    Visible

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

    Methods

    Dispose(Boolean)

    Clean up any resources being used.

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

    GetActiveThemeName()

    Gets the active theme name of the ToolTipAdv control.

    Declaration
    public string GetActiveThemeName()
    Returns
    Type Description
    System.String

    Returns the active theme name.

    OnBeforePopup(CancelEventArgs)

    Raises the before popup event, when popup is about to be shown

    Declaration
    protected override void OnBeforePopup(CancelEventArgs args)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs args
    Overrides
    PopupControlContainer.OnBeforePopup(CancelEventArgs)

    ResetBackgroundColor()

    Declaration
    protected virtual void ResetBackgroundColor()

    ResetBorder3DStyle()

    Declaration
    protected virtual void ResetBorder3DStyle()

    ResetRestrictWidth()

    Declaration
    protected virtual void ResetRestrictWidth()

    ShouldSerializeBackgroundColor()

    Declaration
    protected virtual bool ShouldSerializeBackgroundColor()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBorder3DStyle()

    Declaration
    protected virtual bool ShouldSerializeBorder3DStyle()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeRestrictWidth()

    Declaration
    protected virtual bool ShouldSerializeRestrictWidth()
    Returns
    Type Description
    System.Boolean

    UpdateSize()

    Raised when the size of the label's text is changed

    Declaration
    protected virtual void UpdateSize()

    Events

    ThemeNameChanged

    Occurs when theme name of the ToolTipAdv has changed.

    Declaration
    public event ThemeChangedEventHandler ThemeNameChanged
    Event Type
    Type Description
    ThemeChangedEventHandler

    Explicit Interface Implementations

    IVisualStyle.VisualTheme

    Declaration
    string IVisualStyle.VisualTheme { get; set; }
    Returns
    Type Description
    System.String

    IThemeProvider.ControlName

    Gets the name of the control.

    Declaration
    string IThemeProvider.ControlName { get; }
    Returns
    Type Description
    System.String

    Implements

    IPopupControlContainer
    IPopupChild
    INeedKeyboardMessages
    INeedMouseMoveMessages
    IMouseHookHLProcClient
    IKeyboardProcHookClient
    IPopupParent
    IPopupItem
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved