TExcelFile.ConditionallyModifyFormat Method

Overloads

TExcelFile.ConditionallyModifyFormat(TFlxFormat, Integer, Integer, IDrawingConditionalFormat)

Modifies the format of the specified cell if it has a conditional format active. Returns a modified format with the applied conditional format if there was any change, null otherwise.

Syntax

Unit: FlexCel.Core

function TExcelFile.ConditionallyModifyFormat(const format: TFlxFormat; const row: Integer; const col: Integer; out extraInfo: IDrawingConditionalFormat): TFlxFormat; overload;

Parameters

<-> Parameter Type Description
const format TFlxFormat Original format of the cell.
const row Integer Row of the cell (1 based)
const col Integer Column of the cell (1 based)
out extraInfo IDrawingConditional​Format Extra information about the format of the cell, like if it has to draw an icon or a databar.

Returns

If the format is modified by a conditional format, it returns the new format. If there are no changes returns null, to avoid creating new instances of TFlxFormat.

See also

TExcelFile.ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat)

Modifies the format of the specified cell if it has a conditional format active. Returns a modified format with the applied conditional format if there was any change, null otherwise.

Syntax

Unit: FlexCel.Core

function TExcelFile.ConditionallyModifyFormat(const format: TFlxFormat; const row: Integer; const col: Integer; const includeTables: Boolean; out extraInfo: IDrawingConditionalFormat): TFlxFormat; overload; virtual; abstract;

Parameters

<-> Parameter Type Description
const format TFlxFormat Original format of the cell.
const row Integer Row of the cell (1 based)
const col Integer Column of the cell (1 based)
const includeTables Boolean If true and the cell is inside a table, the format for the table will be also taken in account.
out extraInfo IDrawingConditional​Format Extra information about the format of the cell, like if it has to draw an icon or a databar.

Returns

If the format is modified by a conditional format, it returns the new format. If there are no changes returns null, to avoid creating new instances of TFlxFormat.

See also