Method ShowOverlayToolTip

Namespace

Alternet.UI

Assembly

Alternet.UI.Common.dll

ShowOverlayToolTip(object?, object?, MessageBoxIcon?, HVAlignment?, OverlayToolTipFlags, int?)

Displays an overlay tooltip with the specified title, message, and options.

public virtual ObjectUniqueId ShowOverlayToolTip(object? title, object? message, MessageBoxIcon? icon = null, HVAlignment? alignment = null, OverlayToolTipFlags options = OverlayToolTipFlags.DismissAfterInterval, int? dismissIntervalMilliseconds = null)

Parameters

title object

The title of the tooltip. If null, an empty string is used.

message object

The message content of the tooltip. If null, an empty string is used.

icon MessageBoxIcon?

An optional icon to display in the tooltip. If null, no icon is shown.

alignment HVAlignment?

An optional alignment specification for the tooltip. If null, the tooltip is centered horizontally and vertically.

options OverlayToolTipFlags

A set of flags that control the behavior of the tooltip. The default is DismissAfterInterval.

dismissIntervalMilliseconds int?

An optional duration, in milliseconds, after which the tooltip is automatically dismissed. If null, the default interval is used.

Returns

ObjectUniqueId

An ObjectUniqueId that uniquely identifies the displayed tooltip. This can be used to manage or dismiss the tooltip programmatically.

Remarks

This method provides a convenient way to display an overlay tooltip with customizable content, appearance, and behavior. If more advanced customization is required, consider using the overload that accepts an OverlayToolTipParams object.

ShowOverlayToolTip(OverlayToolTipParams)

Displays an overlay tooltip at the specified location with the provided content and removal interval.

public virtual ObjectUniqueId ShowOverlayToolTip(OverlayToolTipParams data)

Parameters

data OverlayToolTipParams

The content, styling and behavior parameters for the tooltip.

Returns

ObjectUniqueId

A unique identifier for the created overlay tooltip, which can be used to manage or remove it later.