Web.DBWeb.TDSTableProducer.FormatCell

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function FormatCell(CellRow, CellColumn: Integer; CellData: string;  const Tag: string; const BgColor: THTMLBgColor; Align: THTMLAlign; VAlign: THTMLVAlign; const Custom: string): string; dynamic;

C++

DYNAMIC System::UnicodeString __fastcall FormatCell(int CellRow, int CellColumn, System::UnicodeString CellData, const System::UnicodeString Tag, const Web::Httpprod::THTMLBgColor BgColor, Web::Httpprod::THTMLAlign Align, Web::Httpprod::THTMLVAlign VAlign, const System::UnicodeString Custom);

Properties

Type Visibility Source Unit Parent
function protected
Web.DBWeb.pas
Web.DBWeb.hpp
Web.DBWeb TDSTableProducer

Description

Returns an HTML tag of a specified type that reflects a set of specified options.

The table producer uses this protected utility to assemble a set of properties into a single HTML tag. FormatCell first generates an OnFormatCell event, so that the application can override any of the properties that control the tag options. Then it assembles the resulting values into the specified tag.

CellRow and CellColumn identify the table cell to be formatted. These parameters are passed to an OnFormatCell event handler so that it can identify the cell.

CellData contains the text displayed in the cell (a data value or column header).

Tag indicates the type of HTML tag to generate (<TD> for data cells, <TH> for column headers).

BgColor specifies the background color of the cell. An OnFormatCell event handler can override this value.

Align specifies the horizontal alignment of CellData within the cell. An OnFormatCell event handler can override this value.

VAlign specifies the vertical alignment of CellData within the cell. An OnFormatCell event handler can override this value.

Custom specifies any other options for the generated HTML tag. An OnFormatCell event handler can override this value.

FormatCell returns a string with the generated HTML tag.

See Also