Method ShowOverlayToolTipWithError

Namespace

Alternet.UI

Assembly

Alternet.UI.Common.dll

ShowOverlayToolTipWithError(object?, object, HVAlignment?, OverlayToolTipFlags, int?)

Displays an overlay tooltip with an error message based on the provided exception.

public virtual ObjectUniqueId ShowOverlayToolTipWithError(object? title, object e, HVAlignment? alignment = null, OverlayToolTipFlags options = OverlayToolTipFlags.DismissAfterInterval, int? dismissIntervalMilliseconds = null)

Parameters

title object

The title of the tooltip. If null, a default error title is used.

e object

The exception message will be displayed in the tooltip. This parameter cannot be null.

alignment HVAlignment?

The horizontal and vertical alignment of the tooltip relative to its target. If null, a default alignment is used.

options OverlayToolTipFlags

Flags that control the behavior of the tooltip, such as whether it dismisses automatically after a set interval. The default value is DismissAfterInterval.

dismissIntervalMilliseconds int?

The time, in milliseconds, after which the tooltip will automatically dismiss if the options include DismissAfterInterval. If null, a default interval is used.

Returns

ObjectUniqueId

An ObjectUniqueId that uniquely identifies the displayed tooltip.

Remarks

This method is a convenience wrapper for displaying error messages in an overlay tooltip. It uses the exception's message as the tooltip content and provides default values for optional parameters when not specified.