Class Tooltip

The tooltip popup type.

Inheritance
Object
Popup
Popup<Tooltip>
AnchorPopup<Tooltip>
Tooltip
Inherited Members
Namespace: Unity.AppUI.UI
Syntax
public sealed class Tooltip : AnchorPopup<Tooltip>

Fields

defaultPlacement

The default placement of the tooltip.

Declaration
public const PopoverPlacement defaultPlacement = PopoverPlacement.Bottom
Field Value
Type Description
PopoverPlacement

Properties

template

The template to display inside the popup.

Declaration
public VisualElement template { get; }
Property Value
Type Description
VisualElement

text

The text to display inside the popup.

Declaration
public string text { get; }
Property Value
Type Description
String

Methods

AnimateViewIn()

Start the animation for this popup.

Declaration
protected override void AnimateViewIn()
Overrides
Unity.AppUI.UI.AnchorPopup<Unity.AppUI.UI.Tooltip>.AnimateViewIn()

AnimateViewOut(DismissType)

Start the hide animation for this popup.

Declaration
protected override void AnimateViewOut(DismissType reason)
Parameters
Type Name Description
DismissType reason
Overrides
Unity.AppUI.UI.AnchorPopup<Unity.AppUI.UI.Tooltip>.AnimateViewOut(Unity.AppUI.Core.DismissType)

Build(VisualElement)

Build a new Tooltip. In the Application element, only one Tooltip is create and moved at the right place when hovering others UI elements. The Tooltip is handled by the Unity.AppUI.UI.TooltipManipulator.

Declaration
public static Tooltip Build(VisualElement referenceView)
Parameters
Type Name Description
VisualElement referenceView

An arbitrary UI element used as reference for the application context to attach to the popup.
Returns
Type Description
Tooltip

A Tooltip instance.

FindSuitableParent(VisualElement)

Find the parent VisualElement where the popup will be added. This is usually one of the layers from the Panel root UI element.

Declaration
protected override VisualElement FindSuitableParent(VisualElement element)
Parameters
Type Name Description
VisualElement element

An arbitrary UI element inside the panel.
Returns
Type Description
VisualElement

The popup container VisualElement in the current panel.
Overrides

SetContent(VisualElement)

Set the content of the tooltip.

Declaration
public Tooltip SetContent(VisualElement content)
Parameters
Type Name Description
VisualElement content

The content to display inside the tooltip.

Returns
Type Description
Tooltip

The Tooltip.

Remarks

Passing null will clear the content of the tooltip.

SetText(String)

Set a new value for the text property.

Declaration
public Tooltip SetText(string value)
Parameters
Type Name Description
String value

The new value (will be localized).

Returns
Type Description
Tooltip

The Tooltip.

ShouldAnimate()

Implement this method to know if the popup should call AnimateViewIn() and AnimateViewOut(DismissType) methods or not.

Declaration
protected override bool ShouldAnimate()
Returns
Type Description
Boolean

True if you want to animate the popup, False otherwise.
Overrides