New to Telerik UI for WinForms? Start a free 30-day trial

Provides the ownership, data-binding, and change-notification behavior shared by heat map data items.

Definition

Namespace:Telerik.WinControls.UI.HeatMap

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public abstract class HeatMapDataItem : IDataItem, INotifyPropertyChanged, IDisposable

Inheritance: objectHeatMapDataItem

Derived Classes: CategoricalHeatMapItemHeatMapItem

Implements: IDataItemIDisposableINotifyPropertyChanged

Constructors

Initializes an item that is not yet associated with a heat map definition.

C#
public HeatMapDataItem()

Properties

Gets or sets the source object represented by this item.

C#
[Browsable(false)]
public object DataBoundItem { get; set; }

Implements: IDataItem.DataBoundItem

Gets the number of bound properties available through this item's owner, or zero when it has no list source.

C#
public int FieldCount { get; }

Implements: IDataItem.FieldCount

Gets whether this item has an owner with a non-null data source.

C#
protected bool IsDataBound { get; }

Gets the heat map definition associated with this item for data binding and ownership tracking.

C#
[Browsable(false)]
public HeatMapDefinition Owner { get; }

Gets or sets the tag.

C#
[Bindable(true)]
[TypeConverter(typeof(StringConverter))]
public object Tag { get; set; }

Gets or sets a bound property by its position in the owner's bound-property list.

C#
public object this[int index] { get; set; }
Parameters:indexint

The zero-based bound-property index.

Implements: IDataItem.this[int]

Returns null and ignores assignments when no list source is available.

Gets or sets a bound property by name.

C#
public object this[string name] { get; set; }
Parameters:namestring

The bound-property name.

Implements: IDataItem.this[string]

Returns null and ignores assignments when no list source is available.

Methods

Releases resources held by the item; the base implementation has no resources to release.

C#
public virtual void Dispose()

Implements: IDisposable.Dispose()

Gets a bound member from the source object, traversing dotted names as nested properties.

C#
protected object GetValue(string propertyName)
Parameters:propertyNamestring

The bound member name or dotted property path.

Returns:

object

The resolved value, null for an empty name, or the source object if lookup raises ArgumentException.

Finds a bound property by name.

C#
public int IndexOf(string name)
Parameters:namestring

The property name to find.

Returns:

int

The property's index, or -1 if no property matches. Returns zero when this item has no list source.

Implements: IDataItem.IndexOf(string)

Raises PropertyChanged with the supplied change details.

C#
protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs args)
Parameters:argsPropertyChangedEventArgs

The property-change event data.

Raises PropertyChanged for the specified property name.

C#
protected virtual void OnNotifyPropertyChanged(string propertyName)
Parameters:propertyNamestring

The name of the changed property.

Stores the source object for this item and notifies its owning definition when it has a data source.

C#
protected virtual void SetDataBoundItem(bool dataBinding, object value)
Parameters:dataBindingbool

A legacy flag that the current implementation does not inspect.

valueobject

The source object associated with this item.

Events

Occurs when this item reports a property change; the base implementation raises it for owner, tag, and data-bound item changes.

C#
public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged