TTMSFNCDataGridConditionalFormatting.GetOverlayInfo Method

Computes the overlay (data bar fraction or icon index) to paint for a cell.

API unit family: TMSFNCDataGridConditionalFormatting Declaring type: TTMSFNCDataGridConditionalFormatting

Syntax

function GetOverlayInfo(const AProvider: ITMSFNCDataGridFormatProvider; AColumn, ARow: Integer; out AInfo: TTMSFNCDataGridOverlayInfo): Boolean;

Remarks

The renderer calls this when painting a cell overlay and paints using together with the matching rule's TTMSFNCDataGridFormatRuleItem.DataBar / TTMSFNCDataGridFormatRuleItem.IconSet settings.

Parameters

Name	Description
AProvider	The grid-data provider used to read cell values and statistics.
AColumn	Zero-based column index of the cell being evaluated.
ARow	Zero-based row index of the cell being evaluated.
AInfo	Receives the overlay kind and paint values when the function returns True.

Returns

False when no overlay rule applies to the cell; otherwise True.