Class RadHeatMapElement

Represents the main visual element that renders a heat map visualization with data cells, headers, legend, and title. This element provides the core functionality for displaying tabular data as a color-coded matrix with support for interactive features like selection, hover tracking, and tool tips.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadHeatMapElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadHeatMapElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadHeatMapElement()

Initializes a new instance of the RadHeatMapElement class.

Declaration
public RadHeatMapElement()

Fields

cellIndicesToRects

Declaration
public IDictionary<CellIndex, RectangleF> cellIndicesToRects
Field Value
System.Collections.Generic.IDictionary<CellIndex, System.Drawing.RectangleF>

ColumnHeaderHeightProperty

Identifies the ColumnHeaderHeight dependency property for controlling column header cell height.

Declaration
public static RadProperty ColumnHeaderHeightProperty
Field Value
RadProperty

HeaderCellBackColorProperty

Identifies the HeaderCellBackColor dependency property for controlling header cell background color.

Declaration
public static RadProperty HeaderCellBackColorProperty
Field Value
RadProperty

HeaderCellBorderColorProperty

Identifies the HeaderCellBorderColor dependency property for controlling header cell border color.

Declaration
public static RadProperty HeaderCellBorderColorProperty
Field Value
RadProperty

HeaderCellBorderWidthProperty

Identifies the HeaderCellBorderWidth dependency property for controlling header cell border width.

Declaration
public static RadProperty HeaderCellBorderWidthProperty
Field Value
RadProperty

HeaderCellFontProperty

Identifies the HeaderCellFont dependency property for styling header cell text.

Declaration
public static RadProperty HeaderCellFontProperty
Field Value
RadProperty

HeaderCellForeColorProperty

Identifies the HeaderCellForeColor dependency property for controlling header cell text color.

Declaration
public static RadProperty HeaderCellForeColorProperty
Field Value
RadProperty

HeaderCellHoverBackColorProperty

Identifies the HeaderCellHoverBackColor dependency property for controlling header cell background color during mouse hover.

Declaration
public static RadProperty HeaderCellHoverBackColorProperty
Field Value
RadProperty

HeaderCellHoverForeColorProperty

Identifies the HeaderCellHoverForeColor dependency property for controlling header cell text color during mouse hover.

Declaration
public static RadProperty HeaderCellHoverForeColorProperty
Field Value
RadProperty

HoveredCellBorderColorProperty

Identifies the HoveredCellBorderColor dependency property for controlling data cell border color during mouse hover.

Declaration
public static RadProperty HoveredCellBorderColorProperty
Field Value
RadProperty

HoveredCellBorderWidthProperty

Identifies the HoveredCellBorderWidth dependency property for controlling data cell border width during mouse hover.

Declaration
public static RadProperty HoveredCellBorderWidthProperty
Field Value
RadProperty

RowHeaderWidthProperty

Identifies the RowHeaderWidth dependency property for controlling row header cell width.

Declaration
public static RadProperty RowHeaderWidthProperty
Field Value
RadProperty

SelectedCellBorderColorProperty

Identifies the SelectedCellBorderColor dependency property for controlling selected data cell border color.

Declaration
public static RadProperty SelectedCellBorderColorProperty
Field Value
RadProperty

SelectedCellBorderWidthProperty

Identifies the SelectedCellBorderWidth dependency property for controlling selected data cell border width.

Declaration
public static RadProperty SelectedCellBorderWidthProperty
Field Value
RadProperty

Properties

AllowHotTracking

Gets or sets a value indicating whether hot tracking behavior is enabled, allowing cells to be highlighted when hovered.

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

AllowSelection

Gets or sets a value indicating whether cell selection functionality is enabled in the heat map.

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

AutoGenerateLegendItems

Gets or sets a value indicating whether legend items should be generated automatically when ShowLegend is enabled. When true, legend items are automatically created and the VisualItemCreating event is fired for each item. When false, legend items must be added programmatically.

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

CellTextAlignment

Gets or sets the text alignment for content within data cells in the heat map.

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

CellTextFormat

Gets or sets the format string used for displaying data values as text within heat map cells.

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

ColumnHeaderHeight

Gets or sets the height in pixels of column header cells in the heat map.

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

ColumnHeadersPosition

Gets or sets the position of column headers within the heat map layout.

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

ColumnHeaderTextFormat

Gets or sets the format string used for displaying text within column header cells.

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

Definition

Gets or sets the heat map definition that is responsible for managing the data source and organizing data into rows and columns for visualization.

Declaration
public HeatMapDefinition Definition { get; set; }
Property Value
HeatMapDefinition

DescriptionContent

Gets or sets the content of the description cell located in the corner between row and column header cells. Note that the description is not shown if row or column headers are hidden.

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

DisplayCellText

Gets or sets a value indicating whether cell values should be rendered as text within the heat map cells.

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

EmptyCellText

Gets or sets the text content displayed in cells that contain no data or null values. This text is also used as the tool tip text for empty cells.

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

Font

Gets or sets the font used for rendering text within data cells of the heat map. This property defines the font face, size, and style attributes for cell text and is inheritable through the element tree.

Declaration
[RadPropertyDefaultValue("Font", typeof(VisualElement))]
public override Font Font { get; set; }
Property Value
System.Drawing.Font

Overrides

HeaderCellBackColor

Gets or sets the background color for header cells in the heat map.

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

HeaderCellBorderColor

Gets or sets the border color for header cells in the heat map.

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

HeaderCellBorderWidth

Gets or sets the border width in pixels for header cells in the heat map.

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

HeaderCellFont

Gets or sets the font used for rendering text within header cells of the heat map.

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

HeaderCellForeColor

Gets or sets the text color for header cells in the heat map.

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

HeaderCellHoverBackColor

Gets or sets the background color for header cells when the mouse is hovering over them.

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

HeaderCellHoverForeColor

Gets or sets the text color for header cells when the mouse is hovering over them.

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

HeaderCellTextAlignment

Gets or sets the text alignment for content within header cells in the heat map.

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

HoveredCellBorderColor

Gets or sets the border color for data cells when the mouse is hovering over them.

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

HoveredCellBorderWidth

Gets or sets the border width in pixels for data cells when the mouse is hovering over them.

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

HoveredCellIndex

Gets the index of the cell currently being hovered by the mouse cursor.

Declaration
public CellIndex HoveredCellIndex { get; protected set; }
Property Value
CellIndex

Items

Gets a collection of HeatMapDataItem objects that represent the data items displayed in the heat map visualization.

Declaration
public HeatMapDataItemCollection Items { get; }
Property Value
HeatMapDataItemCollection

LegendAlignment

Gets or sets the alignment of the legend element relative to the control layout rectangle.

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

LegendElement

Gets the HeatMapLegendElement that displays the heat map legend.

Declaration
public HeatMapLegendElement LegendElement { get; }
Property Value
HeatMapLegendElement

LegendOrientation

Gets or sets the layout orientation of items within the legend element.

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

LegendPosition

Gets or sets the position of the legend element in the control layout rectangle.

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

LegendStack

Gets the StackLayoutElement that contains the legend element in the heat map layout.

Declaration
public StackLayoutElement LegendStack { get; }
Property Value
StackLayoutElement

LegendTitle

Gets or sets the text displayed as the title of the legend element.

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

LegendValueFormat

Gets or sets the format string used for displaying values in legend items.

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

RowHeadersPosition

Gets or sets the position of row headers within the heat map layout.

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

RowHeaderTextFormat

Gets or sets the format string used for displaying text within row header cells.

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

RowHeaderWidth

Gets or sets the width in pixels of row header cells in the heat map.

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

ScreenTip

This property is not relevant for this class. Use the ScreenTipElement property instead.

Declaration
public override RadScreenTipElement ScreenTip { get; set; }
Property Value
RadScreenTipElement

Overrides

ScreenTipElement

Gets or sets the RadOffice2007ScreenTipElement instance used for displaying screen tips when ToolTipDisplayMode is set to ScreenTip.

Declaration
public virtual RadOffice2007ScreenTipElement ScreenTipElement { get; set; }
Property Value
RadOffice2007ScreenTipElement

SelectedCellBorderColor

Gets or sets the border color for data cells when they are selected in the heat map.

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

SelectedCellBorderWidth

Gets or sets the border width in pixels for data cells when they are selected in the heat map.

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

SelectedCellIndex

Gets or sets the index of the currently selected cell in the heat map.

Declaration
public CellIndex SelectedCellIndex { get; set; }
Property Value
CellIndex

SelectedDataItem

Gets the data item associated with the currently selected cell in the heat map.

Declaration
public HeatMapDataItem SelectedDataItem { get; }
Property Value
HeatMapDataItem

ShowLegend

Gets or sets a value indicating whether the legend element should be displayed in the heat map visualization.

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

Title

Gets or sets the title text displayed above the heat map visualization.

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

TitleElement

Gets the HeatMapTitleElement that displays the heat map title.

Declaration
public HeatMapTitleElement TitleElement { get; }
Property Value
HeatMapTitleElement

TitleStack

Gets the StackLayoutElement that contains the title element in the heat map layout.

Declaration
public StackLayoutElement TitleStack { get; }
Property Value
StackLayoutElement

ToolTip

Gets or sets the RadToolTip instance used for displaying tool tips when ToolTipDisplayMode is set to ToolTip.

Declaration
public RadToolTip ToolTip { get; set; }
Property Value
RadToolTip

ToolTipDisplayMode

Gets or sets the display mode for tool tips shown when hovering over heat map cells.

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

WrapCellText

Gets or sets a value indicating whether text should be wrapped within data cells when it exceeds the cell width.

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

WrapHeaderCellText

Gets or sets a value indicating whether text should be wrapped within header cells when it exceeds the cell width.

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

Methods

AddStylePropertySetting(IPropertySetting)

Adds a style property setting and clears the internal cache to ensure proper rendering updates.

Declaration
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)
Parameters
IPropertySetting setting

The property setting to add.
Returns
ValueUpdateResult

A ValueUpdateResult indicating the result of the operation.
Overrides

ArrangeOverride(SizeF)

Arranges the heat map element and its child elements within the specified final size.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final System.Drawing.SizeF for arranging the element.
Returns
System.Drawing.SizeF

The actual System.Drawing.SizeF used by the heat map element.
Overrides

CreateChildElements()

Creates and initializes the child elements including title stack, title element, legend stack, and legend element.

Declaration
protected override void CreateChildElements()
Overrides

CreateLegendElement()

Creates a new HeatMapLegendElement instance for displaying the heat map legend.

Declaration
protected virtual HeatMapLegendElement CreateLegendElement()
Returns
HeatMapLegendElement

A new HeatMapLegendElement instance associated with this heat map element.

CreateLegendStack()

Creates a new StackLayoutElement instance to contain the heat map legend element.

Declaration
protected virtual StackLayoutElement CreateLegendStack()
Returns
StackLayoutElement

A new StackLayoutElement instance for legend layout.

CreateScreenTipElement()

Creates a new RadOffice2007ScreenTipElement instance for displaying screen tips when hovering over heat map cells.

Declaration
protected virtual RadOffice2007ScreenTipElement CreateScreenTipElement()
Returns
RadOffice2007ScreenTipElement

A new RadOffice2007ScreenTipElement instance with empty caption, main text, and footer text.

CreateTitleElement()

Creates a new HeatMapTitleElement instance for displaying the heat map title.

Declaration
protected virtual HeatMapTitleElement CreateTitleElement()
Returns
HeatMapTitleElement

A new HeatMapTitleElement instance.

CreateTitleStack()

Creates a new StackLayoutElement instance to contain the heat map title element.

Declaration
protected virtual StackLayoutElement CreateTitleStack()
Returns
StackLayoutElement

A new StackLayoutElement instance for title layout.

CreateToolTip()

Creates a new RadToolTip instance for displaying tool tips when hovering over heat map cells.

Declaration
protected virtual RadToolTip CreateToolTip()
Returns
RadToolTip

A new RadToolTip instance attached to the element tree's root element.

DisposeManagedResources()

Releases the managed resources used by the RadHeatMapElement and optionally releases the unmanaged resources.

Declaration
protected override void DisposeManagedResources()
Overrides

GetCellIndex(Point, out Int32, out Int32)

Determines the cell index at the specified location within the heat map content area.

Declaration
protected virtual void GetCellIndex(Point location, out int rowIndex, out int columnIndex)
Parameters
System.Drawing.Point location

The point location to check.
System.Int32 rowIndex

When this method returns, contains the row index of the cell at the specified location.
System.Int32 columnIndex

When this method returns, contains the column index of the cell at the specified location.

GetContentPaintRectangle()

Calculates and returns the content rectangle available for painting the heat map, excluding borders, padding, title, and legend areas.

Declaration
protected virtual Rectangle GetContentPaintRectangle()
Returns
System.Drawing.Rectangle

A System.Drawing.Rectangle representing the available area for heat map content.

GetFormattedString(Object, String)

Declaration
public virtual string GetFormattedString(object header, string format)
Parameters
System.Object header

System.String format

Returns
System.String

GetFormattedText(Double)

Declaration
protected virtual string GetFormattedText(double value)
Parameters
System.Double value

Returns
System.String

InitializeFields()

Initializes the default field values for the heat map element properties and appearance settings.

Declaration
protected override void InitializeFields()
Overrides

ManageToolTip(Point, Int32, Int32)

Manages the display of tool tips and screen tips based on the current mouse location and cell index.

Declaration
protected virtual void ManageToolTip(Point location, int rowIndex, int columnIndex)
Parameters
System.Drawing.Point location

The current mouse location.
System.Int32 rowIndex

The row index of the cell at the current location.
System.Int32 columnIndex

The column index of the cell at the current location.

MeasureOverride(SizeF)

Measures the heat map element and its child elements based on the available size.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available System.Drawing.SizeF for measurement.
Returns
System.Drawing.SizeF

The desired System.Drawing.SizeF for the heat map element.
Overrides

OnBoundsChanged(RadPropertyChangedEventArgs)

Handles bounds changes by updating cached cell bounds and invalidating the display.

Declaration
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

A RadPropertyChangedEventArgs that contains the event data.
Overrides

OnCellPainted(HeatMapCellPaintedEventArgs)

Raises the CellPainted event.

Declaration
protected virtual void OnCellPainted(HeatMapCellPaintedEventArgs args)
Parameters
HeatMapCellPaintedEventArgs args

A HeatMapCellPaintedEventArgs that contains the event data.

OnHeaderPainted(HeatMapHeaderCellPaintedEventArgs)

Raises the HeaderCellPainted event.

Declaration
protected virtual void OnHeaderPainted(HeatMapHeaderCellPaintedEventArgs args)
Parameters
HeatMapHeaderCellPaintedEventArgs args

A HeatMapHeaderCellPaintedEventArgs that contains the event data.

OnHeaderPainting(HeatMapHeaderCellPaintingEventArgs)

Raises the HeaderCellPainting event.

Declaration
protected virtual void OnHeaderPainting(HeatMapHeaderCellPaintingEventArgs args)
Parameters
HeatMapHeaderCellPaintingEventArgs args

A HeatMapHeaderCellPaintingEventArgs that contains the event data.

OnHoveredCellIndexChanged(HeatMapIndexChangedEventArgs)

Raises the HoveredCellIndexChanged event.

Declaration
protected virtual void OnHoveredCellIndexChanged(HeatMapIndexChangedEventArgs args)
Parameters
HeatMapIndexChangedEventArgs args

A HeatMapIndexChangedEventArgs that contains the event data.

OnItemPainting(HeatMapCellPaintingEventArgs)

Raises the CellPainting event.

Declaration
protected virtual void OnItemPainting(HeatMapCellPaintingEventArgs args)
Parameters
HeatMapCellPaintingEventArgs args

A HeatMapCellPaintingEventArgs that contains the event data.

OnLoaded()

Handles the element loaded event by updating the legend visibility and configuration.

Declaration
protected override void OnLoaded()
Overrides

OnMouseDown(MouseEventArgs)

Handles the mouse down event by updating the selected cell index when selection is enabled.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseLeave(EventArgs)

Handles the mouse leave event by hiding screen tips and resetting hover states.

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

An System.EventArgs that contains the event data.
Overrides

OnMouseMove(MouseEventArgs)

Handles the mouse move event by updating hover tracking and managing tool tip display.

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

A System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property changes by updating the internal cache and triggering necessary updates for display properties.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

A RadPropertyChangedEventArgs that contains the event data.
Overrides

OnScreenTipShowing(HeatMapScreenTipEventArgs)

Raises the ScreenTipShowing event.

Declaration
protected virtual void OnScreenTipShowing(HeatMapScreenTipEventArgs args)
Parameters
HeatMapScreenTipEventArgs args

A HeatMapScreenTipEventArgs that contains the event data.

OnSelectedCellIndexChanged(HeatMapIndexChangedEventArgs)

Raises the SelectedCellIndexChanged event.

Declaration
protected virtual void OnSelectedCellIndexChanged(HeatMapIndexChangedEventArgs args)
Parameters
HeatMapIndexChangedEventArgs args

A HeatMapIndexChangedEventArgs that contains the event data.

OnSelectedCellIndexChanging(HeatMapIndexChangingEventArgs)

Raises the SelectedCellIndexChanging event.

Declaration
protected virtual void OnSelectedCellIndexChanging(HeatMapIndexChangingEventArgs args)
Parameters
HeatMapIndexChangingEventArgs args

A HeatMapIndexChangingEventArgs that contains the event data.

OnShowScreenTip(ComponentInputBehavior)

Prevents the default screen tip behavior from being executed.

Declaration
protected override bool OnShowScreenTip(ComponentInputBehavior inputBehavior)
Parameters
ComponentInputBehavior inputBehavior

The input behavior instance.
Returns
System.Boolean

Always returns false to stop the default screen tip behavior.
Overrides

OnToolTipShowing(HeatMapToolTipEventArgs)

Raises the ToolTipShowing event.

Declaration
protected virtual void OnToolTipShowing(HeatMapToolTipEventArgs args)
Parameters
HeatMapToolTipEventArgs args

A HeatMapToolTipEventArgs that contains the event data.

PaintCell(IGraphics, RectangleF, CellIndex, HeatMapDataItem)

Renders a single data cell with background color, border, and text based on the data item and current state.

Declaration
public virtual void PaintCell(IGraphics graphics, RectangleF rect, CellIndex cellIndex, HeatMapDataItem dataItem)
Parameters
IGraphics graphics

The IGraphics object used for rendering.
System.Drawing.RectangleF rect

The System.Drawing.RectangleF defining the cell's painting area.
CellIndex cellIndex

The CellIndex identifying the cell position.
HeatMapDataItem dataItem

The HeatMapDataItem containing the cell's data.

PaintCellBackground(CellIndex, IGraphics, RectangleF, Color)

Declaration
protected virtual void PaintCellBackground(CellIndex cellIndex, IGraphics graphics, RectangleF rectangle, Color backColor)
Parameters
CellIndex cellIndex

IGraphics graphics

System.Drawing.RectangleF rectangle

System.Drawing.Color backColor

PaintCellBorder(CellIndex, IGraphics, RectangleF, Color, Int32)

Declaration
protected virtual void PaintCellBorder(CellIndex cellIndex, IGraphics graphics, RectangleF rectangle, Color borderColor, int borderWidth)
Parameters
CellIndex cellIndex

IGraphics graphics

System.Drawing.RectangleF rectangle

System.Drawing.Color borderColor

System.Int32 borderWidth

PaintCells(IGraphics)

Renders all data cells in the heat map with their associated colors, borders, and text content.

Declaration
public virtual void PaintCells(IGraphics graphics)
Parameters
IGraphics graphics

The IGraphics object used for rendering.

PaintCellText(CellIndex, IGraphics, RectangleF, String, Color, Font, ContentAlignment)

Declaration
protected virtual void PaintCellText(CellIndex cellIndex, IGraphics graphics, RectangleF rectangle, string text, Color foreColor, Font font, ContentAlignment textAlignment)
Parameters
CellIndex cellIndex

IGraphics graphics

System.Drawing.RectangleF rectangle

System.String text

System.Drawing.Color foreColor

System.Drawing.Font font

System.Drawing.ContentAlignment textAlignment

PaintContent(IGraphics)

Declaration
protected override void PaintContent(IGraphics graphics)
Parameters
IGraphics graphics

Overrides

PaintHeaderCell(IGraphics, CellIndex)

Renders a single header cell at the specified cell index with appropriate styling and content.

Declaration
public virtual void PaintHeaderCell(IGraphics graphics, CellIndex cellIndex)
Parameters
IGraphics graphics

The IGraphics object used for rendering.
CellIndex cellIndex

The CellIndex identifying the header cell to paint.

PaintHeaderCellBackground(CellIndex, IGraphics, RectangleF, Color)

Declaration
protected virtual void PaintHeaderCellBackground(CellIndex cellIndex, IGraphics graphics, RectangleF headerRect, Color backColor)
Parameters
CellIndex cellIndex

IGraphics graphics

System.Drawing.RectangleF headerRect

System.Drawing.Color backColor

PaintHeaderCellBorder(CellIndex, IGraphics, RectangleF, Color, Int32)

Declaration
protected virtual void PaintHeaderCellBorder(CellIndex cellIndex, IGraphics graphics, RectangleF rectangle, Color borderColor, int borderWidth)
Parameters
CellIndex cellIndex

IGraphics graphics

System.Drawing.RectangleF rectangle

System.Drawing.Color borderColor

System.Int32 borderWidth

PaintHeaderCellText(CellIndex, IGraphics, RectangleF, String, Color, Font, ContentAlignment, StringTrimming, StringFormatFlags)

Declaration
protected virtual void PaintHeaderCellText(CellIndex cellIndex, IGraphics graphics, RectangleF headerRect, string headerText, Color foreColor, Font font, ContentAlignment textAlignment, StringTrimming trimming, StringFormatFlags formatFlags)
Parameters
CellIndex cellIndex

IGraphics graphics

System.Drawing.RectangleF headerRect

System.String headerText

System.Drawing.Color foreColor

System.Drawing.Font font

System.Drawing.ContentAlignment textAlignment

System.Drawing.StringTrimming trimming

System.Drawing.StringFormatFlags formatFlags

PaintHeaders(IGraphics)

Renders all header cells including row headers, column headers, and the description corner cell.

Declaration
public virtual void PaintHeaders(IGraphics graphics)
Parameters
IGraphics graphics

The IGraphics object used for rendering.

ResetLegendItems()

Resets and regenerates the visual items in the legend element when the legend is visible.

Declaration
public virtual void ResetLegendItems()

ShouldArrangeChild(RadElement)

Determines whether the specified child element should be arranged during the layout process.

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

The child RadElement to evaluate.
Returns
System.Boolean

True if the child should be arranged; otherwise, false.
Overrides

ShouldMeasureChild(RadElement)

Determines whether the specified child element should be measured during the layout process.

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

The child RadElement to evaluate.
Returns
System.Boolean

True if the child should be measured; otherwise, false.
Overrides

UpdateCachedBounds()

Updates the cached bounds for all cells including row headers, column headers, and data cells in the heat map.

Declaration
public virtual void UpdateCachedBounds()

UpdateLegend()

Declaration
protected virtual void UpdateLegend()

UpdateLegendVisibility()

Declaration
protected virtual void UpdateLegendVisibility()

Events

CellPainted

Occurs after a data cell in the heat map has been painted.

Declaration
public event HeatMapCellPaintedEventHandler CellPainted
Event Type
HeatMapCellPaintedEventHandler

CellPainting

Occurs when a data cell in the heat map is about to be painted, allowing customization of cell appearance.

Declaration
public event HeatMapCellPaitingEventHandler CellPainting
Event Type
HeatMapCellPaitingEventHandler

HeaderCellPainted

Occurs after a row or column header cell has been painted.

Declaration
public event HeatMapHeaderPaintedEventHandler HeaderCellPainted
Event Type
HeatMapHeaderPaintedEventHandler

HeaderCellPainting

Occurs when a row or column header cell is about to be painted, allowing customization of header cell appearance.

Declaration
public event HeatMapHeaderPaintingEventHandler HeaderCellPainting
Event Type
HeatMapHeaderPaintingEventHandler

HoveredCellIndexChanged

Occurs when the hovered cell index changes during mouse movement over the heat map.

Declaration
public event HeatMapIndexChangedEventHandler HoveredCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

ScreenTipShowing

Occurs before a screen tip is displayed, allowing customization or cancellation of the screen tip.

Declaration
public event HeatMapScreenTipEventHandler ScreenTipShowing
Event Type
HeatMapScreenTipEventHandler

SelectedCellIndexChanged

Occurs after the selected cell index has changed in the heat map.

Declaration
public event HeatMapIndexChangedEventHandler SelectedCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

SelectedCellIndexChanging

Occurs before the selected cell index changes, allowing the operation to be cancelled.

Declaration
public event HeatMapIndexChangingEventHandler SelectedCellIndexChanging
Event Type
HeatMapIndexChangingEventHandler

ToolTipShowing

Occurs before a tool tip is displayed, allowing customization or cancellation of the tool tip.

Declaration
public event HeatMapToolTipEventHandler ToolTipShowing
Event Type
HeatMapToolTipEventHandler

Extension Methods