Platoo FReport ComponentsTFDataFindEvent

Contents

Typedef for TFRDataSource OnNeedData event.

Delphi declaration
TFDataFindEvent=function(Sender: TFRDataSource; Action: TFRDataFindAction; var Found: Boolean): Boolean of object;
C++ declaration
typedef bool __fastcall(__closure *TFDataFindEvent)(TFRDataSource *Sender, TFRDataFindAction Action, bool & Found);

Description
Used internally.

TFRBandLine

Contents

Band line types

Delphi declaration
TFRBandLine=(frblTopLine, frblBottomLine);
C++ declaration
enum TFRBandLine { frblTopLine, frblBottomLine };

Description
Value Meaning

frblTopLine Line on top of band

frblBottomLine Line on bottom of band

TFRBandLines

Contents

Set of band line types

Delphi declaration
TFRBandLines=Set of TFRBandLine;
C++ declaration
typedef Set < TFRBandLine, frblTopLine, frblBottomLine > TFRBandLines;

Description
See TFRBandLine .

TFRBandType

Contents

Band types

Delphi declaration
TFRBandType=(frbtPARAGRAPH, frbtDIV);
C++ declaration
enum TFRBandType { frbtPARAGRAPH, frbtDIV };

Description
Used for TFRBand type.

Value Meaning

frbtPARAGRAPH Band will be inserted as paragraph <P>...</P>

frbtDIV Band will be inserted as div <DIV>...</DIV>

TFRButtonType

Contents

Button types

Delphi declaration
TFRButtonType=(frbtButton, frbtReset, frbtSubmit);
C++ declaration
enum TFRButtonType { frbtButton, frbtReset, frbtSubmit };

Description
Value Meaning

frbtButton <INPUT TYPE=BUTTON>, functionality has to be defined by HTML Events .

frbtReset <INPUT TYPE=RESET>, set all inputs on TFRForm to defaults.

frbtSubmit <INPUT TYPE=SUBMIT>, submit TFRForm .

TFRDataFindAction

Contents

Data find action types

Delphi declaration
TFRDataFindAction=(frdaFirst, frdaNext, frdaPrior, frdaLast);
C++ declaration
enum TFRDataFindAction { frdaFirst, frdaNext, frdaPrior, frdaLast };

Description
Value Meaning

frdaFirst Look for the first record in the dataset.

frdaNext Look for the next record in the dataset.

frdaPrior Look for the prior record in the dataset.

frdaLast Look for the last record in the dataset.

TFRDateTimeFlag

Contents

Use to specify if string has to be handled as date, time or datetime.

Delphi declaration
TFRDateTimeFlag=(frdtDate, frdtTime, frdtDateTime);
C++ declaration
enum TFRDateTimeFlag { frdtDate, frdtTime, frdtDateTime };

Description
Value Meaning

frdtDate Date

frdtTime Time

frdtDateTime DateTime

TFRDFun

Contents

Delphi declaration
TFRDFun=procedure of object;
C++ declaration
typedef void __fastcall(__closure *TFRDFun)(void);

Description
Used internally for database management routines.

TFRDrawEvent

Contents

TFRDynamicImage drawing event type

Delphi declaration
TFRDrawEvent=procedure(Sender: TFRComponent; ACanvas: TCanvas; const ImgWidth: Integer; const ImgHeight: Integer) of object;
C++ declaration
typedef void __fastcall(__closure *TFRDrawEvent)(TFRComponent *Sender, Graphics::TCanvas *ACanvas, const int ImgWidth, const int ImgHeight);

Description
ACanvas - image canvas for painting

ImgWidth - image width in pixels

ImgHeight - image height in pixels

TFRExeptionEvent

Contents

Typedef for OnException event handlers.

Delphi declaration
TFRExeptionEvent=procedure(Sendr: TObject; var Ex: Exception; var Handeled: Boolean) of object;
C++ declaration
typedef void __fastcall(__closure *TFRExeptionEvent)(System::TObject *Sendr, Sysutils::Exception *& Ex, bool & Handeled);

Description
Ex Exception object.

Handeled Set true, if exception is handled ; false, if it needs to be re-raised

TFRFormMethod

Contents

Form method types

Delphi declaration
TFRFormMethod=(frfmPOST, frfmGET);
C++ declaration
enum TFRFormMethod { frfmPOST, frfmGET };

Description
HTTP method used to submit data from TFRForm to the server.

Value Meaning

frfmPOST POST

frfmGET GET

The visible difference between POST and GET is, that with GET all the data on the form will be sent to the server as a part of the URL, and it will be visible in the browser's URL bar, while POST method will send the data "silently".

Data volume sent with GET method is limited.

TFRGetBoolValue

Contents

Typedef for events to get value of boolean type.

Delphi declaration
TFRGetBoolValue=procedure(Sendr: TObject; var Value: Boolean) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetBoolValue)(System::TObject *Sendr, bool & Value);

Description
Used internally .

TFRGetCharValue

Contents

Typedef for events to get value of char type.

Delphi declaration
TFRGetCharValue=procedure(Sendr: TObject; var Value: Char) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetCharValue)(System::TObject *Sendr, char & Value);

Description
Used internally.

TFRGetEnabledActions

Contents

Typedef for TFRDataSource OnGetEnabledActions event.

Delphi declaration
TFRGetEnabledActions=procedure(Sendr: TObject; State: AnsiString; List: TStrings) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetEnabledActions)(System::TObject *Sendr, System::AnsiString State, Classes::TStrings *List);

Description
Used internally.

TFRGetEvent

Contents

Typedef for GetDisplayONxxx(void) events.

Delphi declaration
TFRGetEvent=procedure(Sender: TComponent; var Value: AnsiString) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetEvent)(Classes::TComponent *Sender, System::AnsiString & Value);

Description
Used internally.

TFRGetEventFun

Contents

Delphi declaration
TFRGetEventFun=function: AnsiString of object;
C++ declaration
typedef System::AnsiString __fastcall(__closure *TFRGetEventFun)(void);

Description
Used internally to generate HTML events like ONLOAD, ONCLICK etc.

TFRGetIntValue

Contents

Typedef for events to get value of integer type.

Delphi declaration
TFRGetIntValue=procedure(Sendr: TObject; var Value: Integer) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetIntValue)(System::TObject *Sendr, int & Value);

Description
Used internally.

TFRGetNamedBoolValue

Contents

Typedef for events to get parameters in NAME/VALUE pairs where value is of boolean type.

Delphi declaration
TFRGetNamedBoolValue=procedure(Sendr: TObject; Name: AnsiString; var Value: Boolean) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetNamedBoolValue)(System::TObject *Sendr, System::AnsiString Name, bool & Value);

Description
Used internally.

TFRGetNamedStrValue

Contents

Typedef for events to get parameters in NAME/VALUE pairs where value is of string type.

Delphi declaration
TFRGetNamedStrValue=procedure(Sendr: TObject; Name: AnsiString; var Value: AnsiString) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetNamedStrValue)(System::TObject *Sendr, System::AnsiString Name, System::AnsiString & Value);

Description
Used internally.

TFRGetStrValue

Contents

Typedef for events to get value of string type.

Delphi declaration
TFRGetStrValue=procedure(Sender: TObject; var Value: AnsiString) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetStrValue)(System::TObject *Sender, System::AnsiString & Value);

Description

TFRGetStyleEvent

Contents

Typedef for OnGetStyle event.

Delphi declaration
TFRGetStyleEvent=procedure(Sender: TFRComponent; var Value: TFRStyle) of object;
C++ declaration
typedef void __fastcall(__closure *TFRGetStyleEvent)(TFRComponent *Sender, TFRStyle *& Value);

Description
Used internally.

TFRHandleDataAction

Contents

Typedef for TFRDataSource OnRecordDataAction event handler.

Delphi declaration
TFRHandleDataAction=procedure(Sendr: TObject; ActionToDo: AnsiString; var NewState: AnsiString; var DoDefaultHandling: Boolean) of object;
C++ declaration
typedef void __fastcall(__closure *TFRHandleDataAction)(System::TObject *Sendr, System::AnsiString ActionToDo, System::AnsiString & NewState, bool & DoDefaultHandling);

Description

TFRImageAlign

Contents

Alignment types used by TFRCustomImage

Delphi declaration
TFRImageAlign=(friaNone, friaTop, friaBottom, friaMiddle, friaLeft, friaRight);
C++ declaration
enum TFRImageAlign { friaNone, friaTop, friaBottom, friaMiddle, friaLeft, friaRight };

Description
Value Meaning

friaNone alignment not used

friaTop top

friaBottom bottom

friaMiddle middle

friaLeft left

friaRight right

TFRImageMapAreaShapes

Contents

Shape types used by TFRImageMapArea

Delphi declaration
TFRImageMapAreaShapes=(shapRect, shapCircle);
C++ declaration
enum TFRImageMapAreaShapes { shapRect, shapCircle };

Description
Value Meaning

shapRect rectangle

shapCircle circle

TFRLeftRight

Contents

Left-right justify types

Delphi declaration
TFRLeftRight=(frtaLeftJustify, frtaRightJustify);
C++ declaration
enum TFRLeftRight { frtaLeftJustify, frtaRightJustify };

Description
Text justification.

Value Meaning

frtaLeftJustify Left

frtaRightJustify Right

TFRListKind

Contents

List kind types

Delphi declaration
TFRListKind=(frlkUnOrdered, frlkOrdered);
C++ declaration
enum TFRListKind { frlkUnOrdered, frlkOrdered };

Description
Value Meaning

frlkUnOrdered ordered list

frlkOrdered unordered list

TFRListType

Contents

List enumeration types

Delphi declaration
TFRListType=(frlsDisc, frlsSquare, frlsSircle, frlsNumber, frls_a_b_c, frls_A_B_C_, frls_i_ii_iiii, frls_I_II_III);
C++ declaration
enum TFRListType { frlsDisc, frlsSquare, frlsSircle, frlsNumber, frls_a_b_c, frls_A_B_C_, frls_i_ii_iiii, frls_I_II_III };

Description
Value Meaning

frlsDisc List items begin with a disc, unordered lists.

frlsSquare List items begin with a square, unordered lists.

frlsSircle List items begin with a s ircle, unordered lists.

frlsNumber List items begin with a number 1,2,3... , ordered lists.

frls_a_b_c List items begin with a letter a,b,c... , ordered lists.

frls_A_B_C_ List items begin with a capitalized letter A,B,C... , ordered lists.

frls_i_ii_iiii List items begin with a number i,ii,iii... , ordered lists.

frls_I_II_III List items begin with a number I,II,III... , ordered lists.

TFRManagerState

Contents

TFRGroupManager state. Use to find out w h ich child control is being inserted at a given moment.

Delphi declaration
TFRManagerState=(frgmFirst, frgmLast, frgmPrior, frgmNext, frgmGroup);
C++ declaration
enum TFRManagerState { frgmFirst, frgmLast, frgmPrior, frgmNext, frgmGroup };

Description
Value Meaning

frgmFirst Child control being inserted is "First"

frgmLast Child control being inserted is "Last"

frgmPrior Child control being inserted is "Prior"

frgmNext Child control being inserted is "Next"

frgmGroup Child control being inserted is "Group"

TFROnNeedData

Contents

Typedef for TFRDataSource.OnNeedData event.

Delphi declaration
TFROnNeedData=procedure(Sendr: TObject; NeedFirst: Boolean; var Found: Boolean) of object;
C++ declaration
typedef void __fastcall(__closure *TFROnNeedData)(System::TObject *Sendr, bool NeedFirst, bool & Found);

Description
Parameters:

NAME MEANING

NeedFirst true, if t he first record is needed.

Found set to true, if t he record was found.

If OnNeedData event is implemented, it will be triggered once with NeedFirst=true and repeated with NeedFirst=false until Found is returned true.

TFRSetNamedStrValue

Contents

Typedef for events to set parameters in NAME/VALUE pairs where value is of a string type.

Delphi declaration
TFRSetNamedStrValue=procedure(Sendr: TObject; Name, Value: AnsiString) of object;
C++ declaration
typedef void __fastcall(__closure *TFRSetNamedStrValue)(System::TObject *Sendr, System::AnsiString Name, System::AnsiString Value);

Description
Used internally.

TFRSimpleEvent

Contents

Typedef for events without parameters.

Delphi declaration
TFRSimpleEvent=procedure(Sendr: TObject) of object;
C++ declaration
typedef void __fastcall(__closure *TFRSimpleEvent)(System::TObject *Sendr);

Description
Used internally.

TFRStaticType

Contents

Delphi declaration
TFRStaticType=(tfstJavaScript, tfstPRE, tfstHTML);
C++ declaration
enum TFRStaticType { tfstJavaScript, tfstPRE, tfstHTML };

Description
Used to set t he type of TFRStaticText

Value Meaning

tfstJavaScript Content will be inserted as JavaScript functions in <SCRIPT> section. Content must be a valid JavaScript.

tfstPRE Content will be inserted as <PRE> section.

tfstHTML Content will be inserted like a n independent part of t he HTML document. Content must be a valid HTML text.

TFRStringListEvent

Contents

Typedef for events that can ta k e TStrings as a parameter.

Delphi declaration
TFRStringListEvent=procedure(Sendr: TObject; List: TStrings) of object;
C++ declaration
typedef void __fastcall(__closure *TFRStringListEvent)(System::TObject *Sendr, Classes::TStrings *List);

Description
Used internally.

TFRTableBandType

Contents

Table band types

Delphi declaration
TFRTableBandType=(frtbSimple, frdbData);
C++ declaration
enum TFRTableBandType { frtbSimple, frdbData };

Description
Use to set t he table band type.

Value Meaning

frtbSimple Band will be inserted once for t he table.

frdbData Band will be inserted once for each row found in t he dataset linked to TFRTable .