Class TRTFReport2
Unit
RTFReport2
Declaration
type TRTFReport2 = class(TComponent)
Description
RTFReport2 is non visual component which provides functionality for generating reports according prepared RTF template with special TAGs
Hierarchy
Overview
Fields
Methods
 |
procedure Execute(DataSets: array of TDataSet); |
 |
procedure FormatText(const TextToFormat: string; FormatTypes: TRTFTextFormats; WholeWordOnly: boolean = false; const SeekFrom: string = ''; const SeekTo: string = ''); |
 |
procedure ReplaceText(const OldText, NewText: string; WholeWordOnly: boolean = false; const SeekFrom: string = ''; const SeekTo: string = ''); |
Properties
Description
Fields
 |
ExtendedInfo: TStrings; |
content of INFO tag in report template, INFO tag is used for backward comunication from report to application
|
 |
PrinterName: string; |
define name of printer which will be used if Action=aaPrint
|
 |
PrintCopies: byte; |
define number of copies, used if Action=aaPrint
|
 |
RaiseUnknownField: boolean; |
defines whether exception is raised for unknown fields in template
|
Methods
 |
procedure Execute(DataSets: array of TDataSet); |
execute creating of report
|
 |
procedure FormatText(const TextToFormat: string; FormatTypes: TRTFTextFormats; WholeWordOnly: boolean = false; const SeekFrom: string = ''; const SeekTo: string = ''); |
can be called in OnModifyBeforeSave event, formats selected text bold, italic, underline
|
 |
procedure ReplaceText(const OldText, NewText: string; WholeWordOnly: boolean = false; const SeekFrom: string = ''; const SeekTo: string = ''); |
can be called in OnModifyBeforeSave event, replace selected text, new string can contain tag to start/stop superscript or subscript \ˆ => start superscript; \_ => start subscript; \= => end superscipt or subsript
|
Properties
 |
property ExtractEOLAfterIf: boolean read FExtractEOLAfterIf write FExtractEOLAfterIf; |
Define whether EOL after IF, IIF, ELSEIF, ELSEIIF is removed
|
 |
property ReportFile: string read FReportFile write FReportFile; |
Define RTF file name with report template
|
 |
property OutputFile: string read FOutputFile write FOutputFile; |
Define output file name
|
 |
property DefaultCharset: integer read FDefaultCharset write FDefaultCharset default 0; |
Define charset number, which will be used in report
|
 |
property DefaultMemoFormat: TMemoFormat read FDefaultMemoFormat write FDefaultMemoFormat default mfAutoDetect; |
Define default format for BLOB fields
|
 |
property DefaultCalcFormat: string read FDefaultCalcFormat write FDefaultCalcFormat; |
Define default format for calculated values
|
 |
property DefaultNumericFormat: string read FDefaultNumericFormat write FDefaultNumericFormat; |
Define default format for numeric fields
|
 |
property DefaultBooleanFormat: string read FDefaultBooleanFormat write FDefaultBooleanFormat; |
Define default format for boolean fields
|
 |
property DefaultDateFormat: string read FDefaultDateFormat write FDefaultDateFormat; |
Define default format for date fields
|
 |
property DefaultTimeFormat: string read FDefaultTimeFormat write FDefaultTimeFormat; |
Define default format for time fields
|
 |
property ConvertScientificFormat: boolean read FConvertScientificFormat write FConvertScientificFormat default false; |
Define whether scientific format is converted to 123 x 10ˆ3 format using superscript
|
 |
property Variables: TStrings read FVariables write SetVariables; |
Define list of variables and their values which can be used in report template
|
 |
property FieldNotFoundValue: string read FFieldNotFoundValue write FFieldNotFoundValue; |
Defines default value used for fields which is not found
|
 |
property MemoReplaces: TStrings read FMemoReplaces write SetMemoReplaces; |
Defines list of strings which is replaced it memo field, e.g.: <TAB>=; - replace #9 by ; ;=\line - replace ; by end of line
|
 |
property ActionAfter: TActionAfter read FActionAfter write FActionAfter default aaShow; |
Define executed action after report is created
|
 |
property ShowMaximized: boolean read FShowMaximized write FShowMaximized default false; |
Define whether rtf file is opened in maximized window (if rtf editor supports)
|
 |
property OnReadInfo: TNotifyEvent read FOnReadInfo write FOnReadInfo; |
define event which is called for each INFO tag
|
 |
property OnUserCalc: TOnUserCalc read FOnUserCalc write FOnUserCalc; |
define event which is called for getting value of undefined properties
|
 |
property OnReportProcess: TReportProcessEvent read FOnReportProcess write FOnReportProcess; |
define event which is called for each dataset records to show progress of execution
|
 |
property TemplateFormat: TTemplateFormat read FTemplateFormat write FTemplateFormat default tfAutoDetect; |
define format type of template (auto, TXT, RTF)
|
 |
property TxtCodePage: integer read FTxtCodePage write FTxtCodePage default 0; |
define used codepage for inserted data in case of TXT temlate format
|
 |
property AppendToFile: boolean read FAppendToFile write FAppendToFile default false; |
define whether output is appended to existing file (used only for TXT format)
|
 |
property OnModifyBeforeSave: TModifyContent read FModifyBeforeSave write FModifyBeforeSave; |
define event which is called just before saving of result
|
 |
property OnGetTemplateStr: TOnGetTemplateStr read FOnGetTemplateStr write FOnGetTemplateStr; |
define event called instead of loading of template file
|
 |
property ShowSaveErrorDialog: boolean read FShowSaveErrorDialog write FShowSaveErrorDialog default false; |
define whether re-save dialog is shown in case of saving error
|
 |
property ShowProgressBar: boolean read FShowProgressBar write FShowProgressBar default false; |
indicate whether progress bar is shown
|
Generated by PasDoc 0.13.0 on 2016-02-19 08:14:10
|