HypernovaDesktop Components · docs
Binarymission
WinFormsTool Tip › BinaryToolTip

BinaryToolTip

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.Popups

BinaryToolTip .NET is an extended replacement for the standard .NET ToolTip object, providing a wealth of impressive features, including the ever popular Windows XP styled "Balloon ToolTip" style, thereby making it easier for you to develop high quality and outstanding GUI applications.

public sealed class BinaryToolTip : Component,IExtenderProvider

Inherits from / implements: Component, IExtenderProvider

Remarks

In addition to the standard .NET framework’s ToolTip functionality, BinaryToolTip .NET offers the following rich features:

1. Implements IExtenderProvider interface : BinaryToolTip .NET implements the standard IExtenderProvider .NET interface and adds extended tooltip properties to other Controls on the Form.
2. Balloon tooltips : The component supports a style property to display tooltips with the ever popular Windows XP style Balloon tooltip style.
3. Image Support : By setting a simple property, you can display an image along with the tooltip title text
4. Ability to fully support painting with custom colors and font : Using the component's simple properties, you can set the color and font of your choice for displaying the tooltip text, title, its forecolor, backcolor and border color.
5. DropShadow effects : The component can paint the tooltip with or without drop shadows. Using its simple properties, you can easily configure the DropShadows for the tooltip. Also, you can configure the tooltip's dropshadow offset, to give an extended floating effect for the tooltip.
6. ToolTip title : By setting a simple property, you can assign a title text to the tooltip, apart from the usual tooltip text
7. Multiple Tooltip styles : The component provides for two different styles of tooltip, viz., an extended version of the standard tooltip and an XP styled Balloon tooltip.
8. Automatic tooltip location management : The component automatically decides the best location for painting the ToolTip window, based on the screen co-ordinates of the underlying BinaryToolTip enabled controls on your Form.

Members at a glance

BinaryToolTipInitializes a new instance of BinaryToolTip component.
BinaryToolTipInitializes a new instance of BinaryToolTip component.
AutomaticMultiLineSupportGets or sets whether Multiline tooltip feature is automatically supported.
BackColorGets or sets the tooltip's background color.
BalloonEdgeCurveFactorGets or sets the Edge curve factor when the style is Balloon style!
BorderColorGets or sets the tooltip's borderColor color.
CustomWidthGets or sets the custom tooltip window width, based on which a multiline tooltip text will be displayed.
ShadowColorGets or sets the colour the tip's drop shadow is drawn in.
ShadowOffsetGets or sets the tooltip's dropshadow position.
TextForeColorGets or sets the tooltip's main text forecolor.
TitleForeColorGets or sets the tooltip's title foreColor.
TitleWillBeBoldGets or sets whether the tooltip's title will be in bold font or not.
TitleWillBeUnderlinedGets or sets whether the tooltip's title will be underlined or not.
ToolTipHideDelayGets or sets the delay, in milliseconds, before when the tooltip will appear while the mouse is stationary over the target control.
ToolTipHoverDelayGets or sets the delay, in milliseconds, before when the tooltip will appear while the mouse is stationary over the target control.
ToolTipReshowDelayGets or sets the time, in milliseconds, when to reshow the tooltip as the mouse moves to another target control.
ToolTipTextFontGets or sets the tooltip's main text's font.
ToolTipTipStyleAssociates a ToolTip display style with the specified control.
DisposeReleases the resources held by this BinaryToolTip.
GetBinaryToolTipIconRetrieves the tooltip title image associated with the specified control.
GetBinaryToolTipStyleRetrieves the tooltip style associated with the specified control.
GetBinaryToolTipTextRetrieves the tooltip text associated with the specified control.
GetBinaryToolTipTitleRetrieves the tooltip title text associated with the specified control.
SetBinaryToolTipIconAssociates a ToolTip title Image with the specified control.
SetBinaryToolTipStyleAssociates a ToolTip display style with the specified control.
SetBinaryToolTipTextAssociates ToolTip text with the specified control.
SetBinaryToolTipTitleAssociates ToolTip title text with the specified control.

Constructors

BinaryToolTip

public BinaryToolTip()

Initializes a new instance of BinaryToolTip component.

BinaryToolTip

public BinaryToolTip(IContainer ic) : this()

Initializes a new instance of BinaryToolTip component.

Properties

AutomaticMultiLineSupport

public bool AutomaticMultiLineSupport

Gets or sets whether Multiline tooltip feature is automatically supported.

BinarToolTip gives you the ability to automatically display a multiline tooltip, based on a custom width property, without you having to specifically insert NewLine characters.
Set this property to false if you do not want to enable this feature.
The default value is true.

BackColor

public Color BackColor

Gets or sets the tooltip's background color.

BinaryToolTip gives you the ability to define a background color, of your choice, to paint its window.
Set this property to modify the background color of the tooltip.

BalloonEdgeCurveFactor

public int BalloonEdgeCurveFactor

Gets or sets the Edge curve factor when the style is Balloon style!

Use this property to set the curve factor for drawing the edges of the tooltip window when the Tooltip is set to Balloon style.

BorderColor

public Color BorderColor

Gets or sets the tooltip's borderColor color.

BinaryToolTip gives you the ability to define a BorderColor color, of your choice, to paint its window borders.
Set this property to modify the borderColor color of the tooltip.

CustomWidth

public int CustomWidth

Gets or sets the custom tooltip window width, based on which a multiline tooltip text will be displayed.

BinaryToolTip gives you the ability to automatically display a multiline tooltip, based on a custom width property, without you having to specifically insert NewLine characters.
Set this property with a custom width (integer value) of your choice.
Once set with a value, the tooltip window will automatically display the tooltip text on multiple lines, based on the window width so set.
The default value is 100, in logical (96 DPI) units: the width is scaled to the display the tip is shown on.
Note: The minimum value this property can accept is 100 pixels.

ShadowColor

public Color ShadowColor

Gets or sets the colour the tip's drop shadow is drawn in.

The shadow is drawn at a fraction of this colour's opacity and faded out at its edge, so a shadow in black darkens whatever is behind the tip on any theme. A light colour is only right over a darker background than itself.

ShadowOffset

public Point ShadowOffset

Gets or sets the tooltip's dropshadow position.

Use this property to set the distance that the tooltip's shadow will be offset from its main painting area. A larger offset gives the a higher floating appearance of the tooltip above the underlying control.

TextForeColor

public Color TextForeColor

Gets or sets the tooltip's main text forecolor.

BinaryToolTip gives you the ability to define a forecolor color, of your choice, to paint the tooltip text .
Set this property to modify the tooltip text color of the tooltip.
Note: To change the ToolTip title text forecolor, set the TitleForeColor property.

TitleForeColor

public Color TitleForeColor

Gets or sets the tooltip's title foreColor.

BinaryToolTip gives you the ability to define a forecolor color, of your choice, to paint the title text .
Set this property to modify the title text color of the tooltip.
Note: To change the ToolTip text forecolor (not its title), set the TextForeColor property.

TitleWillBeBold

public bool TitleWillBeBold

Gets or sets whether the tooltip's title will be in bold font or not.

BinaryToolTip gives you the ability to set whether the tooltip's title will be in bold font or not.
Set this property to false, to set the tooltip title text to be displayed in Normal font.
By default, the title text will be in bold font, and hence this property is set to true.

TitleWillBeUnderlined

public bool TitleWillBeUnderlined

Gets or sets whether the tooltip's title will be underlined or not.

BinaryToolTip gives you the ability to set whether the tooltip's title will be underlined or not.
Set this property to true, to underline the tooltip title text.
By default, the title text will not be underlined, and hence this property is set to false.

ToolTipHideDelay

public int ToolTipHideDelay

Gets or sets the delay, in milliseconds, before when the tooltip will appear while the mouse is stationary over the target control.

ToolTipHoverDelay

public int ToolTipHoverDelay

Gets or sets the delay, in milliseconds, before when the tooltip will appear while the mouse is stationary over the target control.

ToolTipReshowDelay

public int ToolTipReshowDelay

Gets or sets the time, in milliseconds, when to reshow the tooltip as the mouse moves to another target control.

ToolTipTextFont

public Font ToolTipTextFont

Gets or sets the tooltip's main text's font.

BinaryToolTip gives you the ability to set a Font of your choice, for the tooltip's main text.
Set this property with a valid Font value of your choice.

ToolTipTipStyle

public BinaryToolTipStyle ToolTipTipStyle

Associates a ToolTip display style with the specified control.

BinaryToolTip provides the ability to display tooltips in two different style, viz.,

1. Standard : The standard style denotes the style of painting the Tooltip with a standard rectangular area.
2. Balloon : The balloon style denotes the style of painting the Tooltip with a balloon shaped area, just like the popular Windows XP style ballon styled tooltips.
By default, the style is set to BinaryToolTip's Standard style.
Refer to BinaryToolTipStyle for details on the tooltip styles.

Methods

Dispose

protected override void Dispose(bool disposing)

Releases the resources held by this BinaryToolTip.

disposing
true when called from Dispose; false when called from the finalizer.

GetBinaryToolTipIcon

public Image GetBinaryToolTipIcon(object theAttachedObject)

Retrieves the tooltip title image associated with the specified control.

GetBinaryToolTipStyle

public BinaryToolTipStyle GetBinaryToolTipStyle(object theAttachedObject)

Retrieves the tooltip style associated with the specified control.

GetBinaryToolTipText

public string GetBinaryToolTipText(object theAttachedObject)

Retrieves the tooltip text associated with the specified control.

GetBinaryToolTipTitle

public string GetBinaryToolTipTitle(object theAttachedObject)

Retrieves the tooltip title text associated with the specified control.

SetBinaryToolTipIcon

public void SetBinaryToolTipIcon(object theAttachedObject, Image anImage)

Associates a ToolTip title Image with the specified control.

BinaryToolTip provides the ability to set a title image to the tooltip for a given control.
You can use this method to set a title image for the tooltip for a given control. In addition to specifying the tooltip title image to display for a control, you can also use this method to modify the tooltip title image for a control. Calling the SetBinaryToolTipIcon method more than once for a given control does not specify multiple ToolTip title images to display for a control but instead changes the current ToolTip title iamge for the control. To determine the ToolTip title Image that is associated with a control at run time, you can use the GetBinaryToolTipIcon method.
Note: Ensure this property set with an Image with a maximum of 16 x 16 pixels.

SetBinaryToolTipStyle

public void SetBinaryToolTipStyle(object theAttachedObject, BinaryToolTipStyle theTipStyle)

Associates a ToolTip display style with the specified control.

BinaryToolTip provides the ability to display tooltips in two different style, viz.,

1. Standard : The standard style denotes the style of painting the Tooltip with a standard rectangular area.
2. Balloon : The balloon style denotes the style of painting the Tooltip with a balloon shaped area, just like the popular Windows XP style ballon styled tooltips.
Refer to BinaryToolTipStyle for details on the tooltip styles.

SetBinaryToolTipText

public void SetBinaryToolTipText(object theAttachedObject, string theTipText)

Associates ToolTip text with the specified control.

In addition to specifying the ToolTip text to display for a control, you can also use this method to modify the ToolTip text for a control. Calling the SetBinaryToolTipText method more than once for a given control does not specify multiple ToolTip text to display for a control but instead changes the current ToolTip text for the control. To determine the ToolTip text that is associated with a control at run time, you can use the GetBinaryToolTipText method.

SetBinaryToolTipTitle

public void SetBinaryToolTipTitle(object theAttachedObject, string theTipText)

Associates ToolTip title text with the specified control.

BinaryToolTip provides the ability to set a title text to the tooltip for a given control.
You can use this method to set a title text for the tooltip for a given control. In addition to specifying the tooltip title text to display for a control, you can also use this method to modify the tooltip text for a control. Calling the SetBinaryToolTipTitle method more than once for a given control does not specify multiple ToolTip title text to display for a control but instead changes the current ToolTip title text for the control. To determine the ToolTip title text that is associated with a control at run time, you can use the GetBinaryToolTipTitle method.