Platoo FReport ComponentsTFRComponent

Contents - Events - Methods - Properties

Base class for all components


Description
You will never need to create instance of TFRComponent.


TFRComponent - Events

Contents - TFRComponent - Properties - Methods

DoInsert

Delphi declaration
property DoInsert: TFRGetBoolValue read FDoInsert write FDoInsert;
C++ declaration
__property TFRGetBoolValue DoInsert={ read=FDoInsert, write=FDoInsert }

Description
DoInsert event is triggered before HTML generation starts.

Set Value to false if you want to skip this element, true if you want it to be inserted.

OnGetName

Delphi declaration
property OnGetName: TFRGetStrValue read FGetName write FGetName;
C++ declaration
__property TFRGetStrValue OnGetName={ read=FGetName, write=FGetName }

Description
OnGetName event is used to get name for HTML element.

OnGetONCLICK

Delphi declaration
property OnGetONCLICK: TFRGetEvent read FOnGetONCLICK write FOnGetONCLICK;
C++ declaration
__property TFRGetEvent OnGetONCLICK={ read=FOnGetONCLICK, write=FOnGetONCLICK }

Description
OnGetONCLICK event is used to get value for ONCLICK HTML event.

OnGetONDBLCLICK

Delphi declaration
property OnGetONDBLCLICK: TFRGetEvent read FOnGetONDBLCLICK write FOnGetONDBLCLICK;
C++ declaration
__property TFRGetEvent OnGetONDBLCLICK={ read=FOnGetONDBLCLICK, write=FOnGetONDBLCLICK }

Description
OnGetONDBLCLICK event is used to get value for ONDBLCLICK HTML event.

OnGetONKEYDOWN

Delphi declaration
property OnGetONKEYDOWN: TFRGetEvent read FOnGetONKEYDOWN write FOnGetONKEYDOWN;
C++ declaration
__property TFRGetEvent OnGetONKEYDOWN={ read=FOnGetONKEYDOWN, write=FOnGetONKEYDOWN }

Description
OnGetONKEYDOWN event is used to get value for ONKEYDOWN HTML event.

OnGetONKEYPRESS

Delphi declaration
property OnGetONKEYPRESS: TFRGetEvent read FOnGetONKEYPRESS write FOnGetONKEYPRESS;
C++ declaration
__property TFRGetEvent OnGetONKEYPRESS={ read=FOnGetONKEYPRESS, write=FOnGetONKEYPRESS }

Description
OnKetONKEYPRESS event is used to get value for ONKEYPRESS HTML event.

OnGetONKEYUP

Delphi declaration
property OnGetONKEYUP: TFRGetEvent read FOnGetONKEYUP write FOnGetONKEYUP;
C++ declaration
__property TFRGetEvent OnGetONKEYUP={ read=FOnGetONKEYUP, write=FOnGetONKEYUP }

Description
OnGetONKEYUP event is used to get value for ONKEYUP HTML event.

OnGetONMOUSEDOWN

Delphi declaration
property OnGetONMOUSEDOWN: TFRGetEvent read FOnGetONMOUSEDOWN write FOnGetONMOUSEDOWN;
C++ declaration
__property TFRGetEvent OnGetONMOUSEDOWN={ read=FOnGetONMOUSEDOWN, write=FOnGetONMOUSEDOWN }

Description
OnGetONMOUSEDOWN event is used to get value for ONMOUSEDOWN HTML event.

OnGetONMOUSEMOVE

Delphi declaration
property OnGetONMOUSEMOVE: TFRGetEvent read FOnGetONMOUSEMOVE write FOnGetONMOUSEMOVE;
C++ declaration
__property TFRGetEvent OnGetONMOUSEMOVE={ read=FOnGetONMOUSEMOVE, write=FOnGetONMOUSEMOVE }

Description
OnGetONMOUSEMOVE event is used to get value for ONMOUSEMOVE HTML event.

OnGetONMOUSEOUT

Delphi declaration
property OnGetONMOUSEOUT: TFRGetEvent read FOnGetONMOUSEOUT write FOnGetONMOUSEOUT;
C++ declaration
__property TFRGetEvent OnGetONMOUSEOUT={ read=FOnGetONMOUSEOUT, write=FOnGetONMOUSEOUT }

Description
OnGetMOUSEOUT event is used to get value for ONMOUSEOUT HTML event.

OnGetONMOUSEOVER

Delphi declaration
property OnGetONMOUSEOVER: TFRGetEvent read FOnGetONMOUSEOVER write FOnGetONMOUSEOVER;
C++ declaration
__property TFRGetEvent OnGetONMOUSEOVER={ read=FOnGetONMOUSEOVER, write=FOnGetONMOUSEOVER }

Description
OnGetONMOUSEOVER event is used to get value for ONMOUSEOVER HTML event.

OnGetONMOUSEUP

Delphi declaration
property OnGetONMOUSEUP: TFRGetEvent read FOnGetONMOUSEUP write FOnGetONMOUSEUP;
C++ declaration
__property TFRGetEvent OnGetONMOUSEUP={ read=FOnGetONMOUSEUP, write=FOnGetONMOUSEUP }

Description
OnGetMOUSEUP event is used to get value for ONMOUSEUP HTML event.

OnGetStyle

Delphi declaration
property OnGetStyle: TFRGetStyleEvent read FGetStyleEvent write FGetStyleEvent;
C++ declaration
__property TFRGetStyleEvent OnGetStyle={ read=FGetStyleEvent, write=FGetStyleEvent }

Description
Use OnGetStyle event to set style for element at runtime.


TFRComponent - Methods

Contents - TFRComponent - Properties - Events

EncodeAnsiToURL

Delphi declaration
function EncodeAnsiToURL(const Source: AnsiString): AnsiString;
C++ declaration
virtual System::AnsiString __fastcall EncodeAnsiToURL(const System::AnsiString Source)

Description
Use EncodeAnsiToURL to "translate"strings from usual representation to HTML codes in t he manner used to code URLs.

Usually application does not need to call EncodeAnsiToURL directly, all necessary translations are handled automatically.

EncodeChars

Delphi declaration
function EncodeChars(const Source: AnsiString; KeepQuot: Boolean): AnsiString;
C++ declaration
System::AnsiString __fastcall EncodeChars(const System::AnsiString Source, bool KeepQuot)

Description
Use EncodeChars to "translate"strings from usual representation to HTML codes.

Usually application does not need to call EncodeChars directly, all necessary translations are handled automatically.


TFRComponent - Properties

Contents - TFRComponent - Methods - Events

ActionDataSource

Delphi declaration
property ActionDataSource: TFRDataSource read FActionDataSource write SetDataActionSource;
C++ declaration
__property TFRDataSource *ActionDataSource={ read=FActionDataSource, write=SetDataActionSource, nodefault }

Description
Use ActionDataSource property to setup connection between a visible HTML element and a datasource.

If ActionDataSource and FRDAction have values, resulting HTML document will contain scripts (ONCLICK event handlers) that will trigger database manipulation routines at t he server side.

DisplayStyle

Delphi declaration
property DisplayStyle: TFRStyle read GetDispStyle;
C++ declaration
__property TFRStyle *DisplayStyle={ read=GetDispStyle, nodefault }

Description
Style, that will be used for a given HTML element at a given time.

Reader function of DisplayStyle triggers OnGetStyle event.

FRDAction

Delphi declaration
property FRDAction: TEStringWrap read FDataActionWrap write FDataActionWrap;
C++ declaration
__property Estringwrap::TEStringWrap *FRDAction={ read=FDataActionWrap, write=FDataActionWrap, nodefault }

Description
Use FRDAction property to bind a HTML element with a datasource.

If ActionDataSource and FRDAction have values, resulting HTML document will contain scripts (ONCLICK event handlers) that will trigger database manipulation routines at the server side.

FRParent

Delphi declaration
property FRParent: TFRComponent read GetFRParent;
C++ declaration
__property TFRComponent *FRParent={ read=GetFRParent, nodefault }

Description
Parent component. Used internally.

HName

Delphi declaration
property HName: AnsiString read GetHName write SetHName;
C++ declaration
__property System::AnsiString HName={ read=GetHName, write=SetHName, nodefault }

Description
Use HName property to give name to your HTML element. HTML elements can be referenced by name from scripts inside t he HTML document.

If you leave HName property empty, a name for t he HTML element will be generated from TComponent.Name.

ModuleFileName

Delphi declaration
property ModuleFileName: AnsiString read GetModName;
C++ declaration
__property System::AnsiString ModuleFileName={ read=GetModName, nodefault }

Description
Use ModuleFileName property to get t he name of t he file your application was loaded from. If FRComponents are used inside standalone .exe file, name of the .exe file is returned, if components are used to build ISAPI .dll , name of the .dll is returned.

ONCLICK

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

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

ONDBLCLICK

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

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

ONKEYDOWN

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

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

ONKEYPRESS

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

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

ONKEYUP

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

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

ONMOUSEDOWN

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

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

ONMOUSEMOVE

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

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

ONMOUSEOUT

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

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

ONMOUSEOVER

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

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

ONMOUSEUP

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

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

ParentForm

Delphi declaration
property ParentForm: TFRForm read GetParentForm;
C++ declaration
__property TFRForm *ParentForm={ read=GetParentForm, nodefault }

Description
TFRForm component, that contains given component. Used internally.

ParentReport

Delphi declaration
property ParentReport: TFReport read GetParentReport;
C++ declaration
__property TFReport *ParentReport={ read=GetParentReport, nodefault }

Description
TFReport component, that contains given component. Used internally.

Style

Delphi declaration
property Style: TFRStyle read FStyle write SetStyle;
C++ declaration
__property TFRStyle *Style={ read=FStyle, write=SetStyle, nodefault }

Description
TFRStyle component, used to set style.