TExcelFile.GetHtmlFromCell Method

Overloads

TExcelFile.GetHtmlFromCell(Integer, Integer, THtmlVersion, THtmlStyle, TEncoding)

Returns the contents of formatted cell as HTML. Conditional formats are not applied (unless includeCellFormatting is true): you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style to get the cell with cf applied. If ShowFormulaText is true, it will return the formula text instead of the value. For a list of HTML tags that might be returned, see the Remarks section.

Remarks

Text will be returned as standard HTML, on the version specified. This means that for example a < sign will be returned as "&lt;". For a list of all "&" possible symbols consult any HTML reference. &[HexadecimalUnicodeCharacer] might be returned too.

Multiple spaces will be returned as "&nbsp;" (non breaking space) and line breaks will be returned as tags.

The tags that might be returned by this method are: If htmlStyle is Simple:

  • b - Bold.
  • i - Italics.
  • u - Underline.
  • s - Strikeout.
  • sub - Subscript.
  • sup - Superscript.
  • font - Change the used font. This tag behaves as normal HTML, and you can specify color, face, point-size or size as attributes. Size might be between 1 and 7, and the size in points are 8, 9, 12, 14, 18, 24, 34 for each size. You can also specify relative sizes (for example -1)

If htmlStyle is CSS: The equivalent CSS style commands to the ones listed under htmlStyle = Simple.

Syntax

Unit: FlexCel.Core

function TExcelFile.GetHtmlFromCell(const row: Integer; const col: Integer; const htmlVersion: THtmlVersion; const htmlStyle: THtmlStyle; const encoding: TEncoding): string; overload;

Parameters

<-> Parameter Type Description
const row Integer Cell Row (1 based)
const col Integer Cell Column (1 based)
const htmlVersion THtmlVersion Version of the HTML returned. In XHTML, single tags have a "/" at the end, while in 4.0 they don't.
const htmlStyle THtmlStyle Specifies if to use simple tags or CSS for the returned HTML.
const encoding TEncoding Encoding for the returned string. Use UTF-8 if in doubt.

Returns

An HTML formatted string with the cell contents.

See also

TExcelFile.GetHtmlFromCell(Integer, Integer, THtmlVersion, THtmlStyle, TEncoding, Boolean)

Returns the contents of formatted cell as HTML. Conditional formats are not applied (unless includeCellFormatting is true): you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style to get the cell with cf applied. If ShowFormulaText is true, it will return the formula text instead of the value. For a list of HTML tags that might be returned, see the Remarks section.

Remarks

Text will be returned as standard HTML, on the version specified. This means that for example a < sign will be returned as "&lt;". For a list of all "&" possible symbols consult any HTML reference. &[HexadecimalUnicodeCharacer] might be returned too.

Multiple spaces will be returned as "&nbsp;" (non breaking space) and line breaks will be returned as tags.

The tags that might be returned by this method are: If htmlStyle is Simple:

  • b - Bold.
  • i - Italics.
  • u - Underline.
  • s - Strikeout.
  • sub - Subscript.
  • sup - Superscript.
  • font - Change the used font. This tag behaves as normal HTML, and you can specify color, face, point-size or size as attributes. Size might be between 1 and 7, and the size in points are 8, 9, 12, 14, 18, 24, 34 for each size. You can also specify relative sizes (for example -1)

If htmlStyle is CSS: The equivalent CSS style commands to the ones listed under htmlStyle = Simple.

Syntax

Unit: FlexCel.Core

function TExcelFile.GetHtmlFromCell(const row: Integer; const col: Integer; const htmlVersion: THtmlVersion; const htmlStyle: THtmlStyle; const encoding: TEncoding; const includeCellFormatting: Boolean): string; overload; virtual; abstract;

Parameters

<-> Parameter Type Description
const row Integer Cell Row (1 based)
const col Integer Cell Column (1 based)
const htmlVersion THtmlVersion Version of the HTML returned. In XHTML, single tags have a "/" at the end, while in 4.0 they don't.
const htmlStyle THtmlStyle Specifies if to use simple tags or CSS for the returned HTML.
const encoding TEncoding Encoding for the returned string. Use UTF-8 if in doubt.
const includeCellFormatting Boolean If true, the result will include the cell formatting in the formatting. So if for example a cell is formatted as bold, and the string inside doesn't have formatting, this method will return "<b>Text</b>" when includeCellFormatting is true, and just "Text" when it is false. If this parameter is true, it will also consider the conditional formatting of the cell.

Returns

An HTML formatted string with the cell contents.

See also