Back to Devexpress

TdxComponentPrinter.EnumPagesAsImages(Integer[],TGraphicClass,Boolean,TdxEnumPagesAsImagesProc,Pointer,Pointer,Pointer,TBasedxReportLink) Method

vcl-dxpscore-dot-tdxcomponentprinter-dot-enumpagesasimages-x28-integer-tgraphicclass-boolean-tdxenumpagesasimagesproc-pointer-pointer-pointer-tbasedxreportlink-x29.md

latest3.4 KB
Original Source

TdxComponentPrinter.EnumPagesAsImages(Integer[],TGraphicClass,Boolean,TdxEnumPagesAsImagesProc,Pointer,Pointer,Pointer,TBasedxReportLink) Method

Converts report pages to graphic images.

Declaration

delphi
procedure EnumPagesAsImages(const APageIndexes: array of Integer; AGraphicClass: TGraphicClass; ADrawBackground: Boolean; ACallBackProc: TdxEnumPagesAsImagesProc; ACallBackData: Pointer; AProgressData: Pointer; APrepareData: Pointer; AReportLink: TBasedxReportLink = nil);

Parameters

NameType
APageIndexesInteger
AGraphicClassTGraphicClass
ADrawBackgroundBoolean
ACallBackProcTdxEnumPagesAsImagesProc
ACallBackDataPointer
AProgressDataPointer
APrepareDataPointer
AReportLinkTBasedxReportLink

Remarks

The EnumPagesAsImages method is called within the SavePagesAsImagesToDisk method to obtain report pages for the report link specified by the AReportLink parameter in graphic representation.

The APageIndexes parameter specifies absolute indexes of report pages used in specific events.

The AGraphicClass parameter specifies the image type.

Set the ADrawBackground parameter to True to draw the original background within an image.

The ACallBackData, AProgressData and APrepareData parameters determine pointers to arbitrary data which is used in the TdxEnumPagesAsImagesProc procedure, as well as in the OnExportProgress and OnExportPrepareGraphic events.

The TdxEnumPagesAsImagesProc procedure includes the following parameters:

ParameterDescription
AComponentPrinterDetermines the component printer which sends data.
AReportLinkDetermines the report link whose report is being converted.
AIndexDetermines the zero-based index of the exported report page among other pages.
APageIndexDetermines the absolute index of the current page within a report, passed via the APageIndexes parameter of the EnumPagesAsImages method.
AGraphicSpecifies the image created for a specific page.
ADataContains the pointer to additional arbitrary data which is determined by the ACallBackData parameter of the EnumPagesAsImages method.
AContinueSet this parameter to True to continue converting report pages to graphic images or to False , to break all operations.

See Also

TdxComponentPrinter.SavePagesAsImagesToDisk

TdxComponentPrinter Class

TdxComponentPrinter Members

dxPSCore Unit