Table of Contents

Interface IRichToolTip

Namespace
Alternet.UI
Assembly
Alternet.UI.Common.dll

Allows to show, hide and customize tooltip.

public interface IRichToolTip

Properties

AbstractToolTipControl

Gets AbstractControl which is used as provider for IRichToolTip. This property may return null as interface provider may not ne derived from AbstractControl.

ShowDelayInMilliseconds

Gets tooltip show delay in milliseconds.

TimeoutInMilliseconds

Gets tooltip show timeout in milliseconds. If null, DefaultToolTipTimeout is used.

ToolTipBackgroundBrush

Gets tooltip background brush.

ToolTipBackgroundColor

Gets tooltip background color.

ToolTipBorder

Gets tooltip border.

ToolTipControl

Gets RichToolTip which is used as provider for IRichToolTip. This property may return null as some other control may be used as a provider. In this case use AbstractToolTipControl.

ToolTipForegroundColor

Gets tooltip foreground color.

ToolTipIcon

Gets Tooltip icon.

ToolTipImage

Gets Tooltip image.

ToolTipTitleFont

Gets font of the tooltip title.

ToolTipTitleForegroundColor

Gets foreground color of the tooltip title.

Methods

HideToolTip()

Hides tooltip.

OnlyImage(ImageSet?)

Configures tooltip to show only the specified image.

ResetText()

Clears text of the tooltip.

ResetTitle()

Clears title of the tooltip.

SetIcon(ImageSet?)

Sets tooltip image using ImageSet.

SetIcon(MessageBoxIcon?)

Sets tooltip image using MessageBoxIcon enum.

SetTimeout(uint?, uint)

Sets timeout after which the tooltip should disappear, in milliseconds. If 0 is specified, tooltip will not be hidden automatically. Optionally specify a show delay.

SetTitleFont(Font?)

Sets font of the title.

SetTitleForegroundColor(Color?)

Sets foreground color of the title.

SetToolTip(object, bool)

Sets tooltip properties so it will be a simple tooltip.

SetToolTip(object?, object?, MessageBoxIcon?, uint?)

Sets tooltip properties.

SetToolTipBackgroundBrush(Brush?)

Sets the background brush.

SetToolTipBackgroundColor(Color?)

Sets tool tip background color.

SetToolTipForegroundColor(Color?)

Sets foreground color of the message text.

SetToolTipFromTemplate(TemplateControl, Color?)

Initializes tooltip to show image built using the specified control template.

ShowToolTip(PointD?)

Shows previously configured tooltip at the specified location in client coordinates of the tooltip container.

ShowToolTip(object, bool, PointD?)

Shows simple tooltip at the specified location in client coordinates of the tooltip container.

ShowToolTip(object?, object?, MessageBoxIcon?, uint?, PointD?)

Shows tooltip on the screen.

ShowToolTipFromTemplate(TemplateControl, Color?, PointD?)

Shows tooltip with the image built using the specified control template Tooltip is shown at the specified location specified in the client coordinates of the tooltip container.