Back to Devexpress

SunburstCenterLabel.TextPattern Property

windowsforms-devexpress-dot-xtratreemap-dot-sunburstcenterlabel.md

latest2.9 KB
Original Source

SunburstCenterLabel.TextPattern Property

Gets or sets the pattern that formats the sunburst’s center label text.

Namespace : DevExpress.XtraTreeMap

Assembly : DevExpress.XtraTreeMap.v25.2.dll

NuGet Package : DevExpress.TreeMap

Declaration

csharp
[XtraSerializableProperty]
public string TextPattern { get; set; }
vb
<XtraSerializableProperty>
Public Property TextPattern As String

Property Value

TypeDescription
String

The format string that configures the sunburst’s center label text.

|

Remarks

The text pattern can contain plain text, special placeholders and format specifiers.

The following table lists the placeholders you can use in patterns:

PlaceholderDescription
{TV}Shows the sunburst top level items’ total value.

Example

This example customizes sunburst center label text and appearance.

Use the SunburstControl.CenterLabel property to access the following settings:

TextPatternSpecifies center label text. You can use {TV} to display the total value of top level items. Use specifiers to format the value.DXTextFontAllows you to configure font attributes.ForegroundColor / BackgroundColorDefine foreground and background colors.

csharp
sunburstControl.CenterLabel.TextPattern = "Total: ${TV : F2}";
sunburstControl.CenterLabel.DXTextFont = new DXFont("Tahoma", 10);
sunburstControl.CenterLabel.ForegroundColor = Color.Blue;
sunburstControl.CenterLabel.BackgroundColor = Color.Beige;
vb
sunburstControl.CenterLabel.TextPattern = "Total: ${TV : F2}"
sunburstControl.CenterLabel.DXTextFont = New DXFont("Tahoma", 10)
sunburstControl.CenterLabel.ForegroundColor = Color.Blue
sunburstControl.CenterLabel.BackgroundColor = Color.Beige

See Also

SunburstCenterLabel Class

SunburstCenterLabel Members

DevExpress.XtraTreeMap Namespace