Platoo TXReport TTXReport

Contents - Events - Methods - Properties

TTXReport component.


Description
TTXReport component is used to control report generation, printing and Preview processes.


TTXReport - Events

Contents - TTXReport - Properties - Methods

OnNeedData
Delphi declaration
property OnNeedData;
C++ declaration
__property OnNeedData

TTXReport - Methods

Contents - TTXReport - Properties - Events

Prepare

Delphi declaration
procedure Prepare;
C++ declaration
virtual void __fastcall Prepare(void)

Description
Call Prepare to launch the actual report generation process.

NOTE: if you call Prepare, you must also call Unprepare to free the resources located by Prepare.

Preview

Delphi declaration
procedure Preview;
C++ declaration
virtual void __fastcall Preview(void)

Description
Use Preview to open a preview of the report.

If report is not prepared before call to Preview, Preview calls Prepare first and Unprepare before exiting.

Print
Print report.

Delphi declaration
procedure Print;
C++ declaration
virtual void __fastcall Print(void)

Description
Use Print to print the report.

If report is not prepared before call to Print, Print calls Prepare first and Unprepare before exiting.

Unprepare

Delphi declaration
procedure Unprepare;
C++ declaration
virtual void __fastcall Unprepare(void)

Description
Use Unperpare to free the resources allocated by Prepare.


TTXReport - Properties

Contents - TTXReport - Methods - Events

ColsPerPage
Delphi declaration
property ColsPerPage;
C++ declaration
__property ColsPerPage
DataSource
Delphi declaration
property DataSource;
C++ declaration
__property DataSource
DetailBand
Delphi declaration
property DetailBand;
C++ declaration
__property DetailBand
FooterOnBottom

Delphi declaration
property FooterOnBottom: Boolean read GetFooterOnBottom write SetFooterOnBottom;
C++ declaration
__property bool FooterOnBottom={ read=GetFooterOnBottom, write=SetFooterOnBottom, nodefault }

Description
Set FooterOnBottom to place the footer bands PageFooter and ReportFooter on bottom of the page, and false to place the footer bands right after detail bands.

LicenceKey

Delphi declaration
property LicenceKey: TEKeyProp read FKeyProp write FKeyProp;
C++ declaration
__property Unkeyprop::TEKeyProp *LicenceKey={ read=FKeyProp, write=FKeyProp, nodefault }

Description
Use LicenceKey to insert the licencing code.

LinesPerPage
Delphi declaration
property LinesPerPage;
C++ declaration
__property LinesPerPage
PageFooter
Page footer.

Delphi declaration
property PageFooter: TTXRBand read FPageFooter write SetPageFooter default Nil;
C++ declaration
__property TTXRBand *PageFooter={ read=FPageFooter, write=SetPageFooter, default=0 }

Description
PageFooter band is inserted at the end of each page of the report.

PageHeader
Page header.

Delphi declaration
property PageHeader: TTXRBand read FPageHeader write SetPageHeader default Nil;
C++ declaration
__property TTXRBand *PageHeader={ read=FPageHeader, write=SetPageHeader, default=0 }

Description
PageHeader band is inserted at the beginning of each page of the report.

Printer

Delphi declaration
property Printer: TTXPrinter read FPrinter write SetPrinter;
C++ declaration
__property TTXPrinter *Printer={ read=FPrinter, write=SetPrinter, nodefault }

Description
Use Printer to choose the printer used to print your report.

ReportFooter
Report footer.

Delphi declaration
property ReportFooter: TTXRBand read FReportFooter write SetReportFooter default Nil;
C++ declaration
__property TTXRBand *ReportFooter={ read=FReportFooter, write=SetReportFooter, default=0 }

Description
ReportFooter band is inserted once at the end of the report.

ReportHeader
Report header.

Delphi declaration
property ReportHeader: TTXRBand read FReportHeader write SetReportHeader default Nil;
C++ declaration
__property TTXRBand *ReportHeader={ read=FReportHeader, write=SetReportHeader, default=0 }

Description
ReportHeader band is inserted once at the beginning of the report.

ReportTitle
Title of report.

Delphi declaration
property ReportTitle: String read FReportTitle write FReportTitle;
C++ declaration
__property System::AnsiString ReportTitle={ read=FReportTitle, write=FReportTitle, nodefault }

Description

TitleBeforeHeader

Delphi declaration
property TitleBeforeHeader: Boolean read FTitleBeforeHeader write FTitleBeforeHeader;
C++ declaration
__property bool TitleBeforeHeader={ read=FTitleBeforeHeader, write=FTitleBeforeHeader, nodefault }

Description
Set TitleBeforeHeader to true to place the ReportHeader band higher than PageHeader.