TExcelFile.GetHeaderOrFooterImage Method

Overloads

TExcelFile.GetHeaderOrFooterImage(THeaderAndFooterKind, THeaderAndFooterPos, TXlsImgType, TStream)

This method returns the images associated to a given section of the header or footer. There can be only one image per section, and you refer it from the header string (see PageHeader and PageFooter) by writing &G. NOTE THAT YOU CAN ONLY USE HEADER AND FOOTER GRAPHICS ON EXCEL XP AND NEWER. Excel 2000 and 97 will still open the file, but they will show no graphics.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.GetHeaderOrFooterImage(const headerAndFooterKind: THeaderAndFooterKind; const section: THeaderAndFooterPos; var imageType: TXlsImgType; const outStream: TStream); overload; virtual; abstract;

Parameters

<-> Parameter Type Description
const headerAndFooterKind THeaderAndFooterKind Type of page for which we want to retrieve the image. You will normally get this value from THeaderAndFooter.GetHeaderAndFooterKind.
const section THeaderAndFooterPos Section of the header or footer for which we want to retrieve the image.
var imageType TXlsImgType Returns the image type for the data returned. (If it is a bmp, jpg or other)
const outStream TStream Stream where the image data will be copied.

See also

TExcelFile.GetHeaderOrFooterImage(THeaderAndFooterKind, THeaderAndFooterPos, TXlsImgType)

This method returns the images associated to a given section of the header or footer. There can be only one image per section, and you refer it from the header string (see PageHeader and PageFooter) by writing &G. NOTE THAT YOU CAN ONLY USE HEADER AND FOOTER GRAPHICS ON EXCEL XP AND NEWER. Excel 2000 and 97 will still open the file, but they will show no graphics.

Syntax

Unit: FlexCel.Core

function TExcelFile.GetHeaderOrFooterImage(const headerAndFooterKind: THeaderAndFooterKind; const section: THeaderAndFooterPos; var imageType: TXlsImgType): TBytes; overload;

Parameters

<-> Parameter Type Description
const headerAndFooterKind THeaderAndFooterKind Type of page for which we want to retrieve the image. You will normally get this value from THeaderAndFooter.GetHeaderAndFooterKind.
const section THeaderAndFooterPos Section of the header or footer for which we want to retrieve the image.
var imageType TXlsImgType Returns the image type for the data returned. (If it is a bmp, jpg or other)

Returns

Bytes for the image. Null if there is no image on this position.

See also