Platoo FReport Components TFReport

Contents - Events - Methods - Properties


Description
TFReport component is responsible for the actual HTML generation process.

Use TFReport as a container for all other FR components.


TFReport - Events

Contents - TFReport - Properties - Methods

OnException

Delphi declaration
property OnException: TFRExeptionEvent read FOnException write FOnException;
C++ declaration
__property TFRExeptionEvent OnException={ read=FOnException, write=FOnException }

Description
OnException event will be triggered , if an exception is raised while generating HTML. Use this event to free resources allocated in OnPrepare event and to take specific recovery actions.

OnGetONCLICK
Delphi declaration
property OnGetONCLICK;
C++ declaration
__property OnGetONCLICK
OnGetONDBLCLICK
Delphi declaration
property OnGetONDBLCLICK;
C++ declaration
__property OnGetONDBLCLICK
OnGetONKEYDOWN
Delphi declaration
property OnGetONKEYDOWN;
C++ declaration
__property OnGetONKEYDOWN
OnGetONKEYPRESS
Delphi declaration
property OnGetONKEYPRESS;
C++ declaration
__property OnGetONKEYPRESS
OnGetONKEYUP
Delphi declaration
property OnGetONKEYUP;
C++ declaration
__property OnGetONKEYUP
OnGetONLOAD

Delphi declaration
property OnGetONLOAD: TFRGetEvent read FOnGetONLOAD write FOnGetONLOAD;
C++ declaration
__property TFRGetEvent OnGetONLOAD={ read=FOnGetONLOAD, write=FOnGetONLOAD }

Description
OnGetONLOAD event is used to get value for ONLOAD HTML event.

OnGetONMOUSEDOWN
Delphi declaration
property OnGetONMOUSEDOWN;
C++ declaration
__property OnGetONMOUSEDOWN
OnGetONMOUSEMOVE
Delphi declaration
property OnGetONMOUSEMOVE;
C++ declaration
__property OnGetONMOUSEMOVE
OnGetONMOUSEOUT
Delphi declaration
property OnGetONMOUSEOUT;
C++ declaration
__property OnGetONMOUSEOUT
OnGetONMOUSEOVER
Delphi declaration
property OnGetONMOUSEOVER;
C++ declaration
__property OnGetONMOUSEOVER
OnGetONMOUSEUP
Delphi declaration
property OnGetONMOUSEUP;
C++ declaration
__property OnGetONMOUSEUP
OnGetONUNLOAD

Delphi declaration
property OnGetONUNLOAD: TFRGetEvent read FOnGetONUNLOAD write FOnGetONUNLOAD;
C++ declaration
__property TFRGetEvent OnGetONUNLOAD={ read=FOnGetONUNLOAD, write=FOnGetONUNLOAD }

Description
OnGetONUNLOAD event is used to get value for ONUNLOAD HTML event.

OnPrepare

Delphi declaration
property OnPrepare: TFRSimpleEvent read FOnPrepare write FOnPrepare;
C++ declaration
__property TFRSimpleEvent OnPrepare={ read=FOnPrepare, write=FOnPrepare }

Description
OnPrepare event will be triggered before HTML generation starts. Use this event to allocate resources, open queries , etc.

OnUnprepare

Delphi declaration
property OnUnprepare: TFRSimpleEvent read FOnUnprepare write FOnUnprepare;
C++ declaration
__property TFRSimpleEvent OnUnprepare={ read=FOnUnprepare, write=FOnUnprepare }

Description
OnUnprepare event will be triggered after t he HTML generation is finished. Use this event to free resources allocated in OnPrepare event.


TFReport - Methods

Contents - TFReport - Properties - Events

InputParamAsBool

Delphi declaration
function InputParamAsBool(ParamName: AnsiString): Boolean;
C++ declaration
bool __fastcall InputParamAsBool(System::AnsiString ParamName)

Description
Use to get boolean representation of a n input parameter.

InputParamAsDateTime

Delphi declaration
function InputParamAsDateTime(ParamName: AnsiString; flag: TFRDateTimeFlag): TDateTime;
C++ declaration
System::TDateTime __fastcall InputParamAsDateTime(System::AnsiString ParamName, TFRDateTimeFlag flag)

Description
Use to get TDateTime representation of a n input parameter.

InputParamAsDouble

Delphi declaration
function InputParamAsDouble(ParamName: AnsiString): double;
C++ declaration
double __fastcall InputParamAsDouble(System::AnsiString ParamName)

Description
Use to get double representation of a n input parameter.

InputParamAsString

Delphi declaration
function InputParamAsString(ParamName: AnsiString): AnsiString;
C++ declaration
System::AnsiString __fastcall InputParamAsString(System::AnsiString ParamName)

Description
Use to get string representation of a n input parameter.

Prepare

Delphi declaration
procedure Prepare(Destination: TStrings);
C++ declaration
void __fastcall Prepare(Classes::TStrings *Destination)

Description
Use to insert an HTML document into a TStrings object. This form cannot give input parameters to your report.

You will not need this method to create ISAPI application.

PrepareP

Delphi declaration
procedure PrepareP(Destination, PathList, ParamsList: TStrings);
C++ declaration
void __fastcall PrepareP(Classes::TStrings *Destination, Classes::TStrings *PathList, Classes::TStrings *ParamsList)

Description
Use to insert a n HTML document into a TStrings object. Give request parameters and t he URL path as TStrings.

You will not need this method to create an ISAPI application.

PreparePP

Delphi declaration
procedure PrepareP(ARequest:TFRISAPIRequest; AResponse:TFRISAPIResponse);
C++ declaration
void __fastcall PrepareP(TFRISAPIRequest* ARequest,TFRISAPIResponse* AResponse )

Description
Use to insert a n HTML document into a TFRISAPIResponse object and use input parameters from TFRISAPIRequest object.

This method is used in ISAPI applications inside TISAPIActionItem.OnAction event.


TFReport - Properties

Contents - TFReport - Methods - Events

Alignment
Delphi declaration
property Alignment;
C++ declaration
__property Alignment
DataSource

Delphi declaration
property DataSource: TFRDataSource read FDefActionSource write SetDataSource;
C++ declaration
__property TFRDataSource *DataSource={ read=FDefActionSource, write=SetDataSource, nodefault }

Description
Main datasource for database co n nected report.

TFRDataSource component, referenced in the DataSource property will be prepared for inserting t he data, it's preparation routines will be called before result HTML is generated.

NOTE: if you are using the TFRGroupManager component or t he database management with control's FRDAction , you must set t he DataSource property to your TFReport component.

EQUIV_Metas

Delphi declaration
property EQUIV_Metas: THTMLMetas read FMetasEquiv write FMetasEquiv;
C++ declaration
__property THTMLMetas *EQUIV_Metas={ read=FMetasEquiv, write=FMetasEquiv, nodefault }

Description
EQUIV_Metas will be inserted int o HTML document in t he form <META HTTP-EQUIV=... CONTENT=...>

InsertAll

Delphi declaration
property InsertAll: Boolean read FInsertAll write FInsertAll default true;
C++ declaration
__property bool InsertAll={ read=FInsertAll, write=FInsertAll, default=1 }

Description
If InsertAll is true , the whole HTML document will be inserted into t he response ; if it is false, only t he part between the <BODY> and </BODY> tags will be inserted.

LicenceKey

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

Description
Use LicenceKey property to insert your licence key code.

NAME_Metas

Delphi declaration
property NAME_Metas: THTMLMetas read FMetas write FMetas;
C++ declaration
__property THTMLMetas *NAME_Metas={ read=FMetas, write=FMetas, nodefault }

Description
NAME_Metas will be inserted int o the HTML document in the form <META NAME=... CONTENT=...>

ONCLICK
Delphi declaration
property ONCLICK;
C++ declaration
__property ONCLICK
ONDBLCLICK
Delphi declaration
property ONDBLCLICK;
C++ declaration
__property ONDBLCLICK
ONKEYDOWN
Delphi declaration
property ONKEYDOWN;
C++ declaration
__property ONKEYDOWN
ONKEYPRESS
Delphi declaration
property ONKEYPRESS;
C++ declaration
__property ONKEYPRESS
ONKEYUP
Delphi declaration
property ONKEYUP;
C++ declaration
__property ONKEYUP
ONLOAD

Delphi declaration
property ONLOAD: AnsiString read FONLOAD write FONLOAD;
C++ declaration
__property System::AnsiString ONLOAD={ read=FONLOAD, write=FONLOAD, nodefault }

Description
Use ONLOAD property to set ONLOAD HTML event at designtime.

ONMOUSEDOWN
Delphi declaration
property ONMOUSEDOWN;
C++ declaration
__property ONMOUSEDOWN
ONMOUSEMOVE
Delphi declaration
property ONMOUSEMOVE;
C++ declaration
__property ONMOUSEMOVE
ONMOUSEOUT
Delphi declaration
property ONMOUSEOUT;
C++ declaration
__property ONMOUSEOUT
ONMOUSEOVER
Delphi declaration
property ONMOUSEOVER;
C++ declaration
__property ONMOUSEOVER
ONMOUSEUP
Delphi declaration
property ONMOUSEUP;
C++ declaration
__property ONMOUSEUP
ONUNLOAD

Delphi declaration
property ONUNLOAD: AnsiString read FONUNLOAD write FONUNLOAD;
C++ declaration
__property System::AnsiString ONUNLOAD={ read=FONUNLOAD, write=FONUNLOAD, nodefault }

Description
Use ONUNLOAD property to set ONUNLOAD HTML event at designtime.

ParamNames

Delphi declaration
property ParamNames: TStringList read FParamNames write SetParamNames;
C++ declaration
__property Classes::TStringList *ParamNames={ read=FParamNames, write=SetParamNames, nodefault }

Description
List of parameter names.

Parameters recieved from t he client and listed in t he ParamNames list can be sent out with TFRHidden component and they will be sent back to the server when the same form is used next time.

Use ParamNames when you need to use the same parameters several times. For example, if you use TFRGroupManager for grouping t he results returned by SQL query, you will need to re-open your SQL query each time when t he user scrolls to another group. If you need parameters for your SQL, you must use t he ParamNames property to set up the list of parameters needed and one TFRHidden component fo r each parameter.

Request

Delphi declaration
Request: TFRISAPIRequest;
C++ declaration
Frisapiapp::TFRISAPIRequest *Request

Description
TFRISAPIRequest object.

Use request to get access to t he request recieved from the client.

Response
Delphi declaration
Response: TFRISAPIResponse;
C++ declaration
Frisapiapp::TFRISAPIResponse *Response

Description
TFRISAPIResponse object.

Use response to get access to the response that will be sent to the client.

Style
Delphi declaration
property Style;
C++ declaration
__property Style
Title

Delphi declaration
property Title: AnsiString read FTitle write FTitle;
C++ declaration
__property System::AnsiString Title={ read=FTitle, write=FTitle, nodefault }

Description
Title of t he HTML document. Most browsers will display the title in t he browser's window title bar.