OptionsToolTip.TooltipFormat Property

Gets or sets the format used to generate a tooltip’s text. This property is in effect if the OptionsToolTip.Tooltip property is set to an empty string.

Namespace: DevExpress.XtraGauges.Win.Base

Assembly: DevExpress.XtraGauges.v24.2.Win.dll

Declaration

C#

[DefaultValue("{1:F2}")]
[XtraSerializableProperty]
public string TooltipFormat { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue("{1:F2}")>
Public Property TooltipFormat As String

Property Value

Type	Default	Description
String	"{1:F2}"	A string that specifies the format to generate a tooltip’s text.

Property Paths

You can access this nested property as listed below:

Object Type	Path to TooltipFormat
BaseGaugeWin	.OptionsToolTip .TooltipFormat

Remarks

Tooltips are enabled if the GaugeControl.ShowToolTips property is set to true.

You can use the TooltipFormat property to specify the format for generating a tooltip’s text. The format string can contain custom text and placeholders used to insert a gauge element’s name and value. The following placeholders are supported:

Placeholder	Description
{0}	Represents the name of the element being hovered over.
{1}	Represents the value/text of the current element. Numeric values can be formatted as described in Composite Formatting.

It’s also possible to specify a tooltip’s text directly via the OptionsToolTip.Tooltip property. If any string is assigned to this property, the TooltipFormat property is ignored.