Method ShowOverlayToolTipSimple

Namespace

Alternet.UI

Assembly

Alternet.UI.Common.dll

ShowOverlayToolTipSimple(object?, HVAlignment, OverlayToolTipFlags)

Displays a simple overlay tooltip with the specified message, alignment, and options.

public virtual ObjectUniqueId ShowOverlayToolTipSimple(object? message, HVAlignment alignment, OverlayToolTipFlags options)

Parameters

message object

The content to display in the tooltip. Can be a string or another object representing the message. If null, the tooltip will not display any content.

alignment HVAlignment

Specifies the horizontal and vertical alignment of the tooltip relative to its target.

options OverlayToolTipFlags

A combination of flags from OverlayToolTipFlags that determine the behavior and appearance and behavior of the tooltip.

Returns

ObjectUniqueId

An ObjectUniqueId representing the unique identifier of the displayed tooltip. This identifier can be used to manage or dismiss the tooltip.

Remarks

This method provides a simplified way to display an overlay tooltip. For more advanced customization, consider using an overload of this method with additional parameters.

ShowOverlayToolTipSimple(object?, PointD?, HVAlignment?, OverlayToolTipFlags, int?)

Displays a simple overlay tooltip with the specified message and optional customization parameters.

public virtual ObjectUniqueId ShowOverlayToolTipSimple(object? message, PointD? location = null, HVAlignment? alignment = null, OverlayToolTipFlags options = OverlayToolTipFlags.DismissAfterInterval, int? dismissIntervalMilliseconds = null)

Parameters

message object

The content to display in the tooltip. If null, an empty string is displayed.

location PointD?

The optional screen location where the tooltip should appear. If null, the tooltip is aligned based on the specified alignment.

alignment HVAlignment?

The optional alignment of the tooltip when location is null. Defaults to centered alignment if not specified.

options OverlayToolTipFlags

Flags that control the behavior of the tooltip, such as whether it dismisses automatically or requires manual dismissal. The default value is DismissAfterInterval.

dismissIntervalMilliseconds int?

The optional time, in milliseconds, after which the tooltip is automatically dismissed. This parameter is only applicable if options includes DismissAfterInterval. If null, a default interval is used.

Returns

ObjectUniqueId

An ObjectUniqueId representing the unique identifier of the displayed tooltip. This can be used to manage or dismiss the tooltip programmatically.

Remarks

If both location and alignment are null, the tooltip defaults to being centered on the screen.