Gets or sets the tool tip. This is a game object property.

Namespace: DigitalRune.Game.UI.Controls
Assembly: DigitalRune.Game.UI (in DigitalRune.Game.UI.dll) Version: 1.1.0.0 (1.1.1.9392)

Syntax

C#
public Object ToolTip { get; set; }
Visual Basic
Public Property ToolTip As Object
	Get
	Set
Visual C++
public:
property Object^ ToolTip {
	Object^ get ();
	void set (Object^ value);
}

Field Value

The tool tip, which is either a UIControl, a String, or an Object (see remarks). The default value is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

If a tool tip is set, the ToolTipManager will automatically display a tool tip if the mouse hovers over the control for certain time without moving.

The tool tip can be a UIControl, a String, or an Object:

  • UIControl: If the tool tip is a control, then the control is shown as the content of the ToolTipControl.
  • String: If the tool tip is a String, then the string will be wrapped in a TextBlock and shown in the ToolTipControl.
  • Object: If the tool tip is an Object, then the string representation of the object will be shown as the tool tip. (The string will be wrapped in a TextBlock and shown in the ToolTipControl.

The user can override this behavior by setting a CreateToolTipContent callback in the ToolTipManager. The callback receives the value stored in ToolTip and returns the UIControl that will be shown in the ToolTipControl.

See Also