Class RadTreeMap

Inheritance
System.Object
RadControl
RadTreeMap
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadTreeMap : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadTreeMap()

Initializes a new instance of the RadTreeMap class.

Declaration
public RadTreeMap()

Properties

Algorithm

Gets or sets the tree map algorithm.

Declaration
public TreeMapAlgorithm Algorithm { get; set; }
Property Value
TreeMapAlgorithm

AllowHotTracking

Gets or sets a value indicating whether the hot tracking behavior is enabled.

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

AllowSelection

Gets or sets a value indicating whether the selection is enabled.

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

Colorizer

Gets or sets the tree map items colorizer.

Declaration
public BaseColorizer Colorizer { get; set; }
Property Value
BaseColorizer

DataSource

Gets or sets the data source.

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

DefaultSize

Gets the default size of the RadTreeMap when a new instance is initialized.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DisplayMember

Gets or sets the display member.

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

EnableGrouping

Gets or sets a value indicating whether the grouping is enabled.

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

GroupBackColor

Gets or sets the group background color.

Declaration
public Color GroupBackColor { get; set; }
Property Value
System.Drawing.Color

GroupBorderColor

Gets or sets the group border color.

Declaration
public Color GroupBorderColor { get; set; }
Property Value
System.Drawing.Color

GroupDescriptors

Gets a collection of GroupDescriptor which are used to define grouping rules over the TreeMapDataItemCollection.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

Groups

Gets a collection containing the groups of the RadTreeMap.

Declaration
public TreeMapDataItemGroupCollection Groups { get; }
Property Value
TreeMapDataItemGroupCollection

GroupTextAlignment

Gets or sets the text alignment of the groups.

Declaration
public ContentAlignment GroupTextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

HoveredGroup

Gets the hovered group.

Declaration
public TreeMapDataItemGroup HoveredGroup { get; }
Property Value
TreeMapDataItemGroup

HoveredItem

Gets the hovered item.

Declaration
public TreeMapDataItem HoveredItem { get; }
Property Value
TreeMapDataItem

HoveredItemBackColor

Gets or sets the hovered item background color.

Declaration
public Color HoveredItemBackColor { get; set; }
Property Value
System.Drawing.Color

HoveredItemBorderColor

Gets or sets the hovered item border color.

Declaration
public Color HoveredItemBorderColor { get; set; }
Property Value
System.Drawing.Color

HoveredItemBorderWidth

Gets or sets the hovered item border width.

Declaration
public int HoveredItemBorderWidth { get; set; }
Property Value
System.Int32

Items

Gets a collection of TreeMapDataItem object which represent the items in RadTreeMap.

Declaration
public TreeMapDataItemCollection Items { get; }
Property Value
TreeMapDataItemCollection

ItemTextAlignment

Gets or sets the text alignment of the items.

Declaration
public ContentAlignment ItemTextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

LegendOrientation

Gets or sets the orientation of the legend items.

Declaration
public Orientation LegendOrientation { get; set; }
Property Value
System.Windows.Forms.Orientation

LegendPosition

Gets or sets the legend position.

Declaration
public RadPosition LegendPosition { get; set; }
Property Value
RadPosition

LegendTitle

Gets or sets the legend title.

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

SelectedGroup

Gets or sets the selected group.

Declaration
public TreeMapDataItemGroup SelectedGroup { get; set; }
Property Value
TreeMapDataItemGroup

SelectedItem

Gets or sets the selected item.

Declaration
public TreeMapDataItem SelectedItem { get; set; }
Property Value
TreeMapDataItem

SelectedItemBackColor

Gets or sets the selected item background color.

Declaration
public Color SelectedItemBackColor { get; set; }
Property Value
System.Drawing.Color

SelectedItemBorderColor

Gets or sets the selected item border color.

Declaration
public Color SelectedItemBorderColor { get; set; }
Property Value
System.Drawing.Color

SelectedItemBorderWidth

Gets or sets the border width of selected item.

Declaration
public int SelectedItemBorderWidth { get; set; }
Property Value
System.Int32

ShowLegend

Gets or sets a value indicating whether legend is shown.

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

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Title

Gets or sets the tree map title.

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

ToolTipDisplayMode

Gets or sets a value indicating how to display tool tips.

Declaration
public ToolTipDisplayMode ToolTipDisplayMode { get; set; }
Property Value
ToolTipDisplayMode

TreeMapElement

Declaration
public RadTreeMapElement TreeMapElement { get; }
Property Value
RadTreeMapElement

ValueMember

Gets or sets the value member.

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

WrapItemText

Gets or sets a value indicating whether to wrap the text of the items.

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

Methods

ColorizeItems()

The colorizer passes through all items ad sets the corresponding background and foreground colors.

Declaration
public virtual void ColorizeItems()

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateTreeMapElement()

Declaration
protected virtual RadTreeMapElement CreateTreeMapElement()
Returns
RadTreeMapElement

EvaluateAlgorithm()

Evaluates the algorithm. When the algorithm passes, each item will have updated Bounds property.

Declaration
public void EvaluateAlgorithm()

Events

AlgorithmEvaluated

Occurs when the Algorithm has been evaluated and all Items have valid Bounds.

Declaration
public event EventHandler AlgorithmEvaluated
Event Type
System.EventHandler

GroupPainted

Occurs when a group and its items have been painted.

Declaration
public event TreeMapGroupPaintedEventHandler GroupPainted
Event Type
TreeMapGroupPaintedEventHandler

GroupPainting

Occurs when an group is about to be painted.

Declaration
public event TreeMapGroupPaitingEventHandler GroupPainting
Event Type
TreeMapGroupPaitingEventHandler

HoveredGroupChanged

Occurs when the hovered group has changed.

Declaration
public event TreeMapGroupChangedEventHandler HoveredGroupChanged
Event Type
TreeMapGroupChangedEventHandler

HoveredItemChanged

Occurs when the hovered item has changed.

Declaration
public event TreeMapItemChangedEventHandler HoveredItemChanged
Event Type
TreeMapItemChangedEventHandler

ItemCreating

Occurs when a TreeMapDataItem needs to be created.

Declaration
public event TreeMapItemCreatingEventHandler ItemCreating
Event Type
TreeMapItemCreatingEventHandler

ItemDataBound

Occurs when a data-bound item is being attached to a TreeMapDataItem.

Declaration
public event TreeMapItemEventHandler ItemDataBound
Event Type
TreeMapItemEventHandler

ItemPainted

Occurs when an item has been painted.

Declaration
public event TreeMapItemPaitedEventHandler ItemPainted
Event Type
TreeMapItemPaitedEventHandler

ItemPainting

Occurs when an item is about to be painted.

Declaration
public event TreeMapItemPaitingEventHandler ItemPainting
Event Type
TreeMapItemPaitingEventHandler

ScreenTipNeeded

Declaration
public override event ScreenTipNeededEventHandler ScreenTipNeeded
Event Type
ScreenTipNeededEventHandler

Overrides

ScreenTipShowing

Occurs when the screen tip is about to be shown. Cancellable.

Declaration
public event TreeMapScreenTipEventHandler ScreenTipShowing
Event Type
TreeMapScreenTipEventHandler

SelectedGroupChanged

Occurs when the selected group has changed.

Declaration
public event TreeMapGroupChangedEventHandler SelectedGroupChanged
Event Type
TreeMapGroupChangedEventHandler

SelectedGroupChanging

Occurs when the selected group is about to be changed. Cancellable.

Declaration
public event TreeMapGroupChangingEventHandler SelectedGroupChanging
Event Type
TreeMapGroupChangingEventHandler

SelectedItemChanged

Occurs when the selected item has changed.

Declaration
public event TreeMapItemChangedEventHandler SelectedItemChanged
Event Type
TreeMapItemChangedEventHandler

SelectedItemChanging

Occurs when the selected item is about to be changed. Cancellable.

Declaration
public event TreeMapItemChangingEventHandler SelectedItemChanging
Event Type
TreeMapItemChangingEventHandler

ToolTipShowing

Occurs when the tool tip is about to be shown. Cancellable.

Declaration
public event TreeMapToolTipEventHandler ToolTipShowing
Event Type
TreeMapToolTipEventHandler

ToolTipTextNeeded

Declaration
public override event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
ToolTipTextNeededEventHandler

Overrides

Extension Methods