Documentation

Class RadHeatMapElement

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, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadHeatMapElement()

Declaration
public RadHeatMapElement()

Fields

cellIndicesToRects

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

ColumnHeaderHeightProperty

Declaration
public static RadProperty ColumnHeaderHeightProperty
Field Value
RadProperty

HeaderCellBackColorProperty

Declaration
public static RadProperty HeaderCellBackColorProperty
Field Value
RadProperty

HeaderCellBorderColorProperty

Declaration
public static RadProperty HeaderCellBorderColorProperty
Field Value
RadProperty

HeaderCellBorderWidthProperty

Declaration
public static RadProperty HeaderCellBorderWidthProperty
Field Value
RadProperty

HeaderCellFontProperty

Declaration
public static RadProperty HeaderCellFontProperty
Field Value
RadProperty

HeaderCellForeColorProperty

Declaration
public static RadProperty HeaderCellForeColorProperty
Field Value
RadProperty

HeaderCellHoverBackColorProperty

Declaration
public static RadProperty HeaderCellHoverBackColorProperty
Field Value
RadProperty

HeaderCellHoverForeColorProperty

Declaration
public static RadProperty HeaderCellHoverForeColorProperty
Field Value
RadProperty

HoveredCellBorderColorProperty

Declaration
public static RadProperty HoveredCellBorderColorProperty
Field Value
RadProperty

HoveredCellBorderWidthProperty

Declaration
public static RadProperty HoveredCellBorderWidthProperty
Field Value
RadProperty

RowHeaderWidthProperty

Declaration
public static RadProperty RowHeaderWidthProperty
Field Value
RadProperty

SelectedCellBorderColorProperty

Declaration
public static RadProperty SelectedCellBorderColorProperty
Field Value
RadProperty

SelectedCellBorderWidthProperty

Declaration
public static RadProperty SelectedCellBorderWidthProperty
Field Value
RadProperty

Properties

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

AutoGenerateLegendItems

Gets or sets a value indicating whether to generate legend items automatically. If true the legend items are automatically created when ShowLegend is set to true. The VisualItemCreating is fired for each created item. If false, the legend items are not created and the developer adds them programmatically.

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

CellTextAlignment

Gets or sets the text alignment of the cells.

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

CellTextFormat

Gets or sets the cell text format string.

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

ColumnHeaderHeight

Gets or sets the height of column headers.

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

ColumnHeadersPosition

Gets or sets the position of the column headers.

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

ColumnHeaderTextFormat

Gets or sets the column header cell text format string.

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

Definition

Gets or sets the heat map definition. The definition is responsible for managing the data and displaying the data in rows and columns.

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 to paint the cell values.

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

EmptyCellText

Gets or sets the text and tool tip text shown in empty cells(with no data or null values).

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

Font

Gets or sets the font. Font type defines a particular format for text, including font face, size, and style attributes.

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

Overrides

HeaderCellBackColor

Gets or sets the header cell background color.

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

HeaderCellBorderColor

Gets or sets the header border color.

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

HeaderCellBorderWidth

Gets or sets the header border width.

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

HeaderCellFont

The font used for header cells.

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

HeaderCellForeColor

Gets or sets the header cell foreground color.

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

HeaderCellHoverBackColor

Gets or sets the header cell mouse over background color.

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

HeaderCellHoverForeColor

Gets or sets the header cell mouse over foreground color.

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

HeaderCellTextAlignment

Gets or sets the text alignment of the header cells.

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

HoveredCellBorderColor

Gets or sets the hovered cell border color.

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

HoveredCellBorderWidth

Gets or sets the hovered cell border width.

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

HoveredCellIndex

Gets the hovered cell index.

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

Items

Gets a collection of HeatMapDataItem objects which represent the items in RadHeatMap.

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 legend element.

Declaration
public HeatMapLegendElement LegendElement { get; }
Property Value
HeatMapLegendElement

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 position of the legend element in the control layout rectangle.

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

LegendStack

Gets the legend stack.

Declaration
public StackLayoutElement LegendStack { get; }
Property Value
StackLayoutElement

LegendTitle

Gets or sets the legend title.

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

LegendValueFormat

Gets or sets the number format of legend items values.

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

RowHeadersPosition

Gets or sets the position of the row headers.

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

RowHeaderTextFormat

Gets or sets the row header cell text format string.

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

RowHeaderWidth

Gets or sets the width of row headers.

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

ScreenTip

Use the ScreenTipElement property.

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

Overrides

ScreenTipElement

Gets or sets the screen tip element. It is displayed when the ToolTipDisplayMode is ScreenTip.

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

SelectedCellBorderColor

Gets or sets the selected cell border color.

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

SelectedCellBorderWidth

Gets or sets the border width of selected cell.

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

SelectedCellIndex

Gets or sets the selected cell index.

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

SelectedDataItem

Gets the selected data item based on the selected cell index.

Declaration
public HeatMapDataItem SelectedDataItem { get; }
Property Value
HeatMapDataItem

ShowLegend

Gets or sets a value indicating whether legend is displayed.

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

Title

Gets or sets the heat map title.

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

TitleElement

Gets the title element.

Declaration
public HeatMapTitleElement TitleElement { get; }
Property Value
HeatMapTitleElement

TitleStack

Gets the title stack.

Declaration
public StackLayoutElement TitleStack { get; }
Property Value
StackLayoutElement

ToolTip

Gets or sets the tool tip. It is displayed when the ToolTipDisplayMode is ToolTip.

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

ToolTipDisplayMode

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

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

WrapCellText

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

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

WrapHeaderCellText

Gets or sets a value indicating whether to wrap the text of row and column header cells.

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

Methods

AddStylePropertySetting(IPropertySetting)

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

Returns
ValueUpdateResult

Overrides

ArrangeOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateLegendElement()

Declaration
protected virtual HeatMapLegendElement CreateLegendElement()
Returns
HeatMapLegendElement

CreateLegendStack()

Declaration
protected virtual StackLayoutElement CreateLegendStack()
Returns
StackLayoutElement

CreateScreenTipElement()

Declaration
protected virtual RadOffice2007ScreenTipElement CreateScreenTipElement()
Returns
RadOffice2007ScreenTipElement

CreateTitleElement()

Declaration
protected virtual HeatMapTitleElement CreateTitleElement()
Returns
HeatMapTitleElement

CreateTitleStack()

Declaration
protected virtual StackLayoutElement CreateTitleStack()
Returns
StackLayoutElement

CreateToolTip()

Declaration
protected virtual RadToolTip CreateToolTip()
Returns
RadToolTip

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

GetCellIndex(Point, out Int32, out Int32)

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

System.Int32 rowIndex

System.Int32 columnIndex

GetContentPaintRectangle()

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

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()

Declaration
protected override void InitializeFields()
Overrides

ManageToolTip(Point, Int32, Int32)

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

System.Int32 rowIndex

System.Int32 columnIndex

MeasureOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides

OnBoundsChanged(RadPropertyChangedEventArgs)

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

Overrides

OnCellPainted(HeatMapCellPaintedEventArgs)

Fires the CellPainted event.

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

The event arguments.

OnHeaderPainted(HeatMapHeaderCellPaintedEventArgs)

Fires the HeaderCellPainted event.

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

The event arguments.

OnHeaderPainting(HeatMapHeaderCellPaintingEventArgs)

Fires the HeaderCellPainting event.

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

The event arguments.

OnHoveredCellIndexChanged(HeatMapIndexChangedEventArgs)

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

OnItemPainting(HeatMapCellPaintingEventArgs)

Fires the CellPainting event.

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

The event arguments.

OnLoaded()

Declaration
protected override void OnLoaded()
Overrides

OnMouseDown(MouseEventArgs)

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

Overrides

OnMouseLeave(EventArgs)

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

Overrides

OnMouseMove(MouseEventArgs)

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

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnScreenTipShowing(HeatMapScreenTipEventArgs)

Fires the ScreenTipShowing event.

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

The event arguments.

OnSelectedCellIndexChanged(HeatMapIndexChangedEventArgs)

Fires the SelectedCellIndexChanged event.

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

The event arguments.

OnSelectedCellIndexChanging(HeatMapIndexChangingEventArgs)

Fires the SelectedCellIndexChanging event.

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

The event arguments.

OnShowScreenTip(ComponentInputBehavior)

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

Returns
System.Boolean

Overrides

OnToolTipShowing(HeatMapToolTipEventArgs)

Fires the ToolTipShowing event.

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

The event arguments.

PaintCell(IGraphics, RectangleF, CellIndex, HeatMapDataItem)

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

System.Drawing.RectangleF rect

CellIndex cellIndex

HeatMapDataItem dataItem

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)

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

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)

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

CellIndex cellIndex

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)

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

ResetLegendItems()

Declaration
public virtual void ResetLegendItems()

ShouldArrangeChild(RadElement)

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

Returns
System.Boolean

Overrides

ShouldMeasureChild(RadElement)

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

Returns
System.Boolean

Overrides

UpdateCachedBounds()

Updates the bounds of the row, column header cells and data cells.

Declaration
public virtual void UpdateCachedBounds()

UpdateLegend()

Declaration
protected virtual void UpdateLegend()

UpdateLegendVisibility()

Declaration
protected virtual void UpdateLegendVisibility()

Events

CellPainted

Occurs when a cell has been painted.

Declaration
public event HeatMapCellPaintedEventHandler CellPainted
Event Type
HeatMapCellPaintedEventHandler

CellPainting

Occurs when an cell is about to be painted.

Declaration
public event HeatMapCellPaitingEventHandler CellPainting
Event Type
HeatMapCellPaitingEventHandler

HeaderCellPainted

Occurs when a row/column header cell has been painted.

Declaration
public event HeatMapHeaderPaintedEventHandler HeaderCellPainted
Event Type
HeatMapHeaderPaintedEventHandler

HeaderCellPainting

Occurs when a row/column header cell is about to be painted.

Declaration
public event HeatMapHeaderPaintingEventHandler HeaderCellPainting
Event Type
HeatMapHeaderPaintingEventHandler

HoveredCellIndexChanged

Occurs when the hovered cell index has changed.

Declaration
public event HeatMapIndexChangedEventHandler HoveredCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

ScreenTipShowing

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

Declaration
public event HeatMapScreenTipEventHandler ScreenTipShowing
Event Type
HeatMapScreenTipEventHandler

SelectedCellIndexChanged

Occurs when the selected cell index has changed.

Declaration
public event HeatMapIndexChangedEventHandler SelectedCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

SelectedCellIndexChanging

Occurs when the selected cell index is about to be changed. Cancellable.

Declaration
public event HeatMapIndexChangingEventHandler SelectedCellIndexChanging
Event Type
HeatMapIndexChangingEventHandler

ToolTipShowing

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

Declaration
public event HeatMapToolTipEventHandler ToolTipShowing
Event Type
HeatMapToolTipEventHandler

Extension Methods