Palettes.GetPalette(String) Method

Returns a palette by its name.

Namespace: DevExpress.XtraTreeMap

Assembly: DevExpress.XtraTreeMap.v23.2.dll

NuGet Package: DevExpress.TreeMap

Declaration

C#

public static Palette GetPalette(
    string name
)

VB.NET

Public Shared Function GetPalette(
    name As String
) As Palette

Parameters

Name	Type	Description
name	String	The palette name.

Returns

Type	Description
Palette	The palette with the name you pass. Returns null (Nothing in Visual Basic) if a palette with the given name is not found.

Example

This example shows how to use the ListBoxControl to display a list of predefined palettes for a TreeMap.

C#

using DevExpress.XtraTreeMap;
using System;
using System.Windows.Forms;
//...
private void OnFormLoad(object sender, EventArgs e) {
    listBoxControl1.DataSource = Palettes.GetNames();
    listBoxControl1.SelectedValueChanged += OnSelectedValueChanged;
}
private void OnSelectedValueChanged(object sender, EventArgs e) {
    TreeMapPaletteColorizerBase paletteColorizer = (TreeMapPaletteColorizerBase)treeMap1.Colorizer;
    paletteColorizer.Palette = Palettes.GetPalette(listBoxControl1.SelectedValue.ToString());
}

VB.NET

Imports DevExpress.XtraTreeMap
Imports System
Imports System.Windows.Forms
'...
Private Sub OnFormLoad(ByVal sender As Object, ByVal e As EventArgs)
    listBoxControl1.DataSource = Palettes.GetNames
    AddHandler listBoxControl1.SelectedValueChanged, AddressOf OnSelectedValueChanged
End Sub

Private Sub OnSelectedValueChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim paletteColorizer = CType(treeMap1.Colorizer, TreeMapPaletteColorizerBase)
    paletteColorizer.Palette = Palettes.GetPalette(listBoxControl1.SelectedValue.ToString)
End Sub

Related TreeMap API:

• Palettes.GetNames - Returns a list of built-in palettes’ names.
• Palettes.GetPalette - Returns a palette by its name.