windowsforms-devexpress-dot-xtratreemap-dot-sunburstlabel.md
Gets or sets the pattern that formats the Sunburst’s label text.
Namespace : DevExpress.XtraTreeMap
Assembly : DevExpress.XtraTreeMap.v25.2.dll
NuGet Package : DevExpress.TreeMap
[DefaultValue("{L}")]
[XtraSerializableProperty]
public string TextPattern { get; set; }
<DefaultValue("{L}")>
<XtraSerializableProperty>
Public Property TextPattern As String
| Type | Default | Description |
|---|---|---|
| String | "{L}" |
The format string that configures the Sunburst’s label text.
|
The text pattern can contain plain text, special placeholders and format specifiers. For example, you can use the “Value: {V:F2}” format string to show a value with two signs after a comma in the item label.
The following table lists the placeholders you can use in patterns:
| Placeholder | Description |
|---|---|
| {L} | Shows the sunburst item label. |
| {V} | Shows the sunburst item value. |
This example demonstrates how to format content and fine-tune the appearance of sunburst item labels.
Use the following API members to customize label text format, appearance and arrangement.
sunburstControl.Label.TextPattern = "{L}: ${V:F2}M";
sunburstControl.Label.DisplayMode = SunburstLabelDisplayMode.Horizontal;
sunburstControl.Label.AutoLayout = true;
sunburstControl.Label.Visible = true;
sunburstControl.ItemStyle.TextColor = Color.DarkSlateBlue;
sunburstControl.ItemStyle.TextGlowColor = Color.White;
sunburstControl.Label.TextPattern = "{L}: ${V:F2}M"
sunburstControl.Label.DisplayMode = SunburstLabelDisplayMode.Horizontal
sunburstControl.Label.AutoLayout = true
sunburstControl.Label.Visible = true
sunburstControl.ItemStyle.TextColor = Color.DarkSlateBlue
sunburstControl.ItemStyle.TextGlowColor = Color.White
The example above uses the following API members:
| Member | Description |
|---|---|
SunburstLabel.TextPattern | Gets or sets the pattern that formats the Sunburst’s label text. |
| SunburstLabel.DisplayMode | Specifies how to align a label within a sunburst item. |
| SunburstLabel.AutoLayout | Indicates whether the adaptive layout is enabled for sunburst item labels. |
| SunburstLabel.Visible | Specifies the visibility of sunburst item labels. |
| SunburstControl.ItemStyle | Returns the sunburst item appearance settings. |
| HierarchicalItemStyle.TextColor | Gets or sets a treemap / sunburst item text color. |
| SunburstItemStyle.TextGlowColor | Gets or sets the glow color of the sunburst item’s text. |
See Also