Class TreeMap

Represents a control that displays hierarchical or flat data as a tree map visualization.

Inheritance
System.Object
BaseControl
TreeMap
Implements
System.IDisposable
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: Syncfusion.Windows.Forms.TreeMap
Assembly: Syncfusion.TreeMap.Windows.dll
Syntax
public class TreeMap : BaseControl, IThemeProvider, IVisualStyle, IDisposable, INotifyPropertyChanged

Constructors

TreeMap()

Initializes a new instance of the TreeMap control.

Declaration
[SecurityCritical]
public TreeMap()

Properties

ColorValuePath

Gets or sets ColorValuePath for the TreeMap control.

Declaration
public string ColorValuePath { get; set; }
Property Value
Type
System.String

GroupColorMappings

Gets or sets GroupColorMappings for the TreeMap control.

Declaration
public List<GroupColorMapping> GroupColorMappings { get; set; }
Property Value
Type
System.Collections.Generic.List<GroupColorMapping>

HeaderBackgroundBrush

To specify the color for treemap header background

Declaration
public Brush HeaderBackgroundBrush { get; set; }
Property Value
Type
System.Drawing.Brush

HeaderBorderBrush

To specify the color for header border brush

Declaration
public Brush HeaderBorderBrush { get; set; }
Property Value
Type
System.Drawing.Brush

HeaderBorderThickness

To specify the header border thickness

Declaration
public float HeaderBorderThickness { get; set; }
Property Value
Type
System.Single

HeaderBrush

To specify the color for treemap header

Declaration
public Brush HeaderBrush { get; set; }
Property Value
Type
System.Drawing.Brush

HeaderFont

To specify the font for treemap header

Declaration
public Font HeaderFont { get; set; }
Property Value
Type
System.Drawing.Font

HeaderToolTipInfo

To specify the header tooltip info

Declaration
public ToolTipInfo HeaderToolTipInfo { get; set; }
Property Value
Type
ToolTipInfo

HighlightBorderBrush

To specify the highlightonselection is true or not

Declaration
public Brush HighlightBorderBrush { get; set; }
Property Value
Type
System.Drawing.Brush

HighlightBorderThickness

To specify the highlightborder thickness

Declaration
public double HighlightBorderThickness { get; set; }
Property Value
Type
System.Double

HighlightGroupOnSelection

To specify highlighting the group of items on selection

Declaration
public bool HighlightGroupOnSelection { get; set; }
Property Value
Type
System.Boolean

HighlightOnSelection

To specify the highlightonselection is true or not

Declaration
public bool HighlightOnSelection { get; set; }
Property Value
Type
System.Boolean

IsTootTipVisible

To specify the tooltip is visible or not

Declaration
public bool IsTootTipVisible { get; set; }
Property Value
Type
System.Boolean

IsVisualStyleEnabled

Gets a value indicating whether the visual style based theme is applied to the control and also indicates whether the theme files are referred from external assemblies or not.

Declaration
public bool IsVisualStyleEnabled { get; }
Property Value
Type Description
System.Boolean

Return true, if the visual style based theme is applied to the control. Otherwise returns false.

ItemsLayoutMode

To specify the item layout mode

Declaration
public ItemsLayoutModes ItemsLayoutMode { get; set; }
Property Value
Type
ItemsLayoutModes

ItemsSource

Gets or sets the item source for the TreeMap control.

Declaration
public object ItemsSource { get; set; }
Property Value
Type
System.Object

ItemToolTipInfo

To specify the Item tooltip info

Declaration
public ToolTipInfo ItemToolTipInfo { get; set; }
Property Value
Type
ToolTipInfo

LabelBackgroundBrush

To specify the label background brush

Declaration
public Brush LabelBackgroundBrush { get; set; }
Property Value
Type
System.Drawing.Brush

LabelBorderBrush

To specify the label border brush

Declaration
public Brush LabelBorderBrush { get; set; }
Property Value
Type
System.Drawing.Brush

LabelBorderThickness

To specify the label border thickness

Declaration
public float LabelBorderThickness { get; set; }
Property Value
Type
System.Single

LabelBrush

To specify the label brush

Declaration
public Brush LabelBrush { get; set; }
Property Value
Type
System.Drawing.Brush

LabelFont

To specify the font style of label

Declaration
public Font LabelFont { get; set; }
Property Value
Type
System.Drawing.Font

LeafColorMapping

Gets or sets LeafColorMapping for the TreeMap control.

Declaration
public ColorMapping LeafColorMapping { get; set; }
Property Value
Type
ColorMapping

LeafItemSettings

Gets or sets LeafItemSettings for the TreeMap control.

Declaration
public LeafItemSettings LeafItemSettings { get; set; }
Property Value
Type
LeafItemSettings

Legends

Gets or sets Legends for the TreeMap control.

Declaration
public List<Legend> Legends { get; set; }
Property Value
Type
System.Collections.Generic.List<Legend>

LegendSetting

To specify the legendsettings

Declaration
public LegendSettings LegendSetting { get; set; }
Property Value
Type
LegendSettings

Levels

Gets or sets Levels for the TreeMap control.

Declaration
public List<TreeMapLevel> Levels { get; set; }
Property Value
Type
System.Collections.Generic.List<TreeMapLevel>

RangeColorMapping

Gets or sets RangeColorMapping for the TreeMap control.

Declaration
public Brush RangeColorMapping { get; set; }
Property Value
Type
System.Drawing.Brush

SelectedItems

Gets or sets the collection of currently selected items in the TreeMap.

Declaration
public ObservableCollection<object> SelectedItems { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<System.Object>

SelectionMode

To specify the selection mode

Declaration
public SelectionModes SelectionMode { get; set; }
Property Value
Type
SelectionModes

ThemeStyle

Gets or sets the TreeMapVisualStyle value used to customize the appearance of the TreeMap.

Declaration
public TreeMapVisualStyle ThemeStyle { get; set; }
Property Value
Type
TreeMapVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

WeightValuePath

To specify the Weightvalue path

Declaration
public string WeightValuePath { get; set; }
Property Value
Type
System.String

Methods

CreateAccessibilityInstance()

Creates the accessibilty for the control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

Accessibility

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

ControlName
Returns
Type
System.String
Overrides

GroupColor(List<TreeMapItem>)

Applies color mappings to TreeMap groups based on predefined group color settings.

Declaration
public void GroupColor(List<TreeMapItem> items)
Parameters
Type Name Description
System.Collections.Generic.List<TreeMapItem> items

A list of TreeMapItem objects to which color mappings will be applied.
Remarks

If a matching group ID is found in the color mappings, the corresponding color mapping is applied to its child items. If no group-level mapping is found, the default leaf color mapping is applied.

OnMouseEnter(EventArgs)

Handles the mouse enter event for the control.

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An EventArgs object that contains the event data.

OnMouseLeave(EventArgs)

Handles the mouse leave event for the control.

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An EventArgs object that contains the event data.

OnMouseMove(MouseEventArgs)

Handles the mouse move event for the control.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A MouseEventArgs object that contains the event data.

OnMouseUp(MouseEventArgs)

Handles the mouse up event for the control.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

A MouseEventArgs object that contains the event data.

OnPaint(PaintEventArgs)

Handles the paint event for the control.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

A PaintEventArgs object that contains the event data.

OnPropertyChanged(String)

Raises the PropertyChanged event for the specified property name.

Declaration
protected virtual void OnPropertyChanged(string propertyName)
Parameters
Type Name Description
System.String propertyName

The name of the property that changed.
Remarks

Notifies any bound controls or listeners that the property value has changed.

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

Events

LeafItemDrawing

Occurs when a leaf item in the TreeMap is about to be drawn. Allows customization of the rendering logic for individual leaf items.

Declaration
public event TreeMap.LeafItemDrawingEventHandler LeafItemDrawing
Event Type
Type
TreeMap.LeafItemDrawingEventHandler

PropertyChanged

Occurs when a property value changes. Used to notify listeners, typically for data binding scenarios.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type
System.ComponentModel.PropertyChangedEventHandler

SelectionChanged

Occurs when the selection within the TreeMap control changes. This event provides information about the previous and current selection states.

Declaration
public event TreeMap.SelectionChangedEventHandler SelectionChanged
Event Type
Type
TreeMap.SelectionChangedEventHandler

TooltipDrawing

Occurs when a tooltip is about to be drawn for a TreeMap item. Allows customization of the tooltip content and appearance before it is displayed.

Declaration
public event TreeMap.TooltipDrawingEventHandler TooltipDrawing
Event Type
Type
TreeMap.TooltipDrawingEventHandler

Implements

System.IDisposable
System.ComponentModel.INotifyPropertyChanged