Ek RTF Report for Delphi
Version 1.85 (D4, D5, D6)


CONTENTS
1. Component description
2. History
3. License
4. Installation
5. Troubleshooting.
6. Contact information

1. COMPONENT DESCRIPTION
TEkRtf report is non visual component that allows you to use all power of MS Word or other rtf-compatible editor
to create, preview, edit and print your reports.

How to use it:
- create report template in MS Word
- save it in RTF format
- place TEkRTF component on form, fill required properties
- prepare data in your application
- run report using one of Execute methods
- run MS Word (or other editor) if you want to view, edit or print your document

For more information see help and demo application.
go top


2. HISTORY

Version 1.85
new procedure InsertRTFMemoStream in the unit ekrtfstream
new procedure InsertRTFMemo in the unit ekrtfstream
double click on TEkUDFList component opens "Functions" editor window
fixed bug with scan while() function on skipping empty scan block

Version 1.82
fixed bug with fdtm() format and constant parameters with database fields
if dataset is on a eof position after OnScanRecord event, scan block skips the empty record
states of report datasets are returned back to EnableControls, if exception raised while processing the report

Version 1.81
format functions and user defined functions accept string and numeric constants as arguments
extended format of scan block with new keyword "while": \Scan(DataSet), While(UDF(...)), .... \ scan block terminated if result of UDF(...) is "false"
scan-endscan block works on a single line of text
new report template function VAR(var1, ..., varN) - creates variables var1 - varN if they don't exist
new option eoNumericFormatClearZero - deletes zero numbers in numeric formats output
fixed bug with output blob jpeg images
new method ShellOpenFile

Version 1.70
created new component TEkUDFList for user defined functions
new property UDFList in TEkRTF component
extended syntax of report template in according with UDF support

Version 1.62
fixed bug with incorrect exception in method SetTemplateBuffer

Version 1.61
more than 26 datasets support
fixed bug with FormatIndex=0 in event OnImageFormat

Version 1.6
new methods for manipulating with report variables: VarByName, ClearVars, CreateVar, FreeVar
extended format of scan block
new keyword \ScanFooter\
total and count functions sum(), ctn(), cts() for scan block commands
new format functions fdtm, ffixr, fnumr
properties DecimalRSeparator, DecimalRTerminator for using with "ffixr" and "fnumr" formats
new option eoDotAsColon
cached structure of dataset files

IMPORTANT: In this version option eoDotAsColon is True by default. It means that all field names like \DataSet.Field\ will be considered as \DataSet:Field\
If you use implicit cycles on MS Word table with field inside that has syntax \DataSet.Field\, you should replace it with \DataSet:Field\ and use keywords \Scan(DataSet)\ and \endscan\
If you still wish to use old (not reliable) method to make cycles, you must set option eoDotAsColon to False in corresponded EKRTF components.

Version 1.50
"noeof" option in "Scan" keyword \Scan(DataSet)[,page][,noeof]\ - scan block will be missed on eof of scanned dataset
new keyword \ScanEntry\
extended syntax for fields with spaces in names
optimized core of report engine
#11 will appear as "line break" control in output file,
#12 will appear as "new page" control in output file

Version 1.48
property ExecuteSuccessful (true if no errors)
property LastErrMsg (contains last error message if Execute report fails)
fixed bug with omitted exceptions
added additional checking to ExecuteOpen method

Version 1.47
"page" option in keyword \Scan(DataSet)[,page]\. Forces to begin new record of scanned DataSet with new page.
New extended syntax for field names: \DataSet:(NNN)\ , NNN is field number in DataSet.

Version 1.45
ExecuteStream method.
New format function flnk() - hyperlink format
ExecuteOpen works from console applications.

Version 1.42
Methods: SetTemplateBuffer, FreeTemplate.
go top


3. LICENSE

TEkRTF COMPONENT IS DISTRIBUTED "AS IS". NO WARRANTY OF ANY KIND IS EXPRESSED OR
IMPLIED. THE AUTHOR WILL NOT BE LIABLE FOR DATA LOSS, DAMAGES OR ANY OTHER KIND
OF LOSS WHILE USING THIS SOFTWARE. THIS PRODUCT IS FREE FOR NON-COMMERCIAL USING
AND EVALUATING. YOU MUST REGISTER YOUR COPY OF EK RTF IF YOU USE IT IN COMMERCIAL
PROJECTS.
THE FREE VERSION OF EK RTF REPORT FILLS THE "AUTHOR" AND "COMMENTS" PROPERTIES OF
OUTPUT DOCUMENT WITH INFORMATION ABOUT THIS PRODUCT.

Registered users will receive source code and updates applicable for current version.
To register this product goto http://ekrtf.code.net.ru/reg.html Also you may go to
directly to registration page

go top


4. INSTALLATION

1. Uninstall previous version of EkRTF:
Select "Component/Install Packages" from the Delphi IDE. Select the package file EComp.bpl,
click "Remove" button, click "OK". Select the package file Edsn.bpl, click "Remove" button, click "OK".
2. Select "Component/Install Packages" from the Delphi IDE.
3. Click on the "Add" button and select the package file EComp.bpl in the directory were it unzipped.
Click "Open" to install the package.
4. Install package Edsn.bpl the same way as Ecomp.bpl
5. Select "Tools/Environment Options" from the Delphi IDE.
6. Select the "Library" tab.
7. Check the path to EComp pakage in "Library Path" edit box. It must reference to location where is the
new version of EkRTF component. Installed component will appear in "Data Access" panel.

HELP INSTALLATION:
1.Copy the files EkRtf.hlp and EkRtf.cnt into the HELP directory in Delphi main directory. Delete files EkRTF.gid from old versions of help.

2.Edit file DELPHI6.CNT (DELPHI5.CNT, DELPHI4.CNT):
After line
:Title Delphi Help
add
:Index TEkRTF report component=ekrtf.hlp

In addition, for Delphi 6 edit file del6vcl.cnt - after line
:Title VCL Reference
add
:Index TEkRTF report component=ekrtf.hlp

Delete file Delphi6.gid (Delphi5.gid, Delphi4.gid) in Delphi help directory, to initiate help index rebuild on next help request in Delphi.

go top


5. TROUBLESHOUTING

Before running demo projects, check that you have application associated with doc and rtf files.
Otherwise output files will be saved on disk, but will not open automatically.
Delete all pathes from menu Tools\Enviroment options\Library\Directories\ which references to
old versions of component. If compiled programm cannot find input rtf file and generates exception place
your compiled exe file into project source directory (directory with source rtf files) or type full path and file
name in property "InputFile".
Check a FAQ page
go top


6. CONTACT INFORMATION

if you have any questions, comments or suggestions email to support@code.net.ru
See the latest version of Ek RTF Report on component home page at http://ekrtf.code.net.ru

go top