LazReport Documentation/de

From Free Pascal wiki
Jump to: navigation, search

Deutsch (de) English (en) español (es)

Überblick

LazReport ist eine Gruppe von Komponenten, um Anwendungen um die Möglichkeit zur Reporterstellung zu erweitern. Es verwendet einen visuellen Designer, um auf Bändern basierende Berichte zu erstellen. Es beinhaltet eine Report Engine mit Vorschaufunktion sowie einen Interpreter, um Benutzerskripte auszuführen. Der Report-Designer kann auch zur Laufzeit aufgerufen werden.

Lizenz

LazReport basiert auf FreeReport 2.32 (von Fast Reports Inc). Es ist unter einer modifizierten LGPL verfügbar, der selben Lizenz wie auch die Lazarus LCL. Die Details stehen in lazreport/license.txt, license-rus.txt und license-lazreport.txt.

Autoren

FreeReport wurde von Fast Reports Inc erstellt. Die erste LazReport Portierung erfolgte durch Olivier Guilbaud. Die Integration in Lazarus sowie zahlreiche Fehlerbehebungen wurden durch Jesus Reyes A. vorgenommen. Zahlreiche weitere Personen haben an LazReport mitgewirkt (siehe lazreport/doc/contributors.txt).

Installation

Um LazReport in die Lazarus IDE zu installieren:

  1. Öffnen sie das Package "LazReport". Menü: Package -> Package-Datei (.lpk) öffnen ...
  2. Wählen sie die Datei "components/lazreport/source/lazreport.lpk"
  3. Klicken sie auf Installieren

Beim nächsten Start von Lazarus sollte es einen Tab "LazReport" in der Komponentenpalette geben.

Dokumentation

Entwickler- und Benutzerhandbücher für LazReport müssen noch geschrieben werden. In der Zwischenzeit sind die meisten LazReport Features im FreeReport Entwicklerhandbuch (siehe lazreport/doc/fr_eng.sxw) beschrieben. Plattform-spezifische Dinge wie OLE Objekte, die dort beschrieben sind, sind noch nicht in LazReport implementiert. Auch sind einige Beispiele bzw. Referenzen darauf nur für Delphi verfügbar.

Bis eine LazReport Dokumentation ausgearbeitet ist, soll diese Wiki-Seite als Aufbewahrungsort für Informationen dienen. Vielleicht können in der Zukunft fehlende Teile aus dieser Seite erstellt werden. Die Benutzer sind aufgerufen, Themen zu ergänzen, zu denen sie eine Dokumentation vermissen.

Exportfilter

Die LazReport Exportfilter werden wie folgt aufgerufen:

  if TheReport.PrepareReport then
    TheReport.ExportTo(TfrHTMExportFilter, 'exportiertedatei.html');

wobei TheReport eine Instanz der Komponente "TfrReport" ist. In diesem Beispiel wird ein TfrHTMExportFilter verwendet, um eine Datei namens 'exportiertedatei.html' zu erstellen. Ist der Bereicht bereits erstellt (prepared), muss er nicht erneut erstellt werden. Um den TfrHTMExportFilter zu nutzen, muss man eine Instanz der Komponente "TfrHTMExportFilter" aus dem Tab "LazReport" in der Komponentenpalette auf dem Formular ablegen (im Formular-Desginer). Alternativ muss die Unit "LR_E_HTM" (Dateiname: lr_e_htm.pas) zum Abschnitt uses der aktuellen Unit hinzugefügt werden.

Seit LazReport 0.9.6 wurde die Exportfilter-Unterstützung verbessert. Jetzt können die Exportfilter Parameter übernehmen, die die Benutzer entweder durch direktes Ändern der Werte oder durch eine Bedienoberfläche (UI) anpassen können. In order to make changes in parameters, the developer can create an event handler for TfrReport.OnExportFilterSetup event, available by selecting the TfrReport component and selecting the Events tab in Object Inspector.

The OnExportFilterSetup (of type TExportFilterSetup) event handler takes an argument sender of type TfrExportFilter, in order to use this types, lr_class.pas unit must be added to unit uses clause. All ExportFilter clases share this event and developer has to type-cast the sender argument to the desired export filter class for example:

if sender is TfrHTMExportFilter then
begin
  TfrHTMExportFilter(sender).UseCSS := false;
end;

Es folgt eine Beschreibung der verfügbaren Exportfilter:

TfrExportFilter

ist die Basisklasse aller Exportfilter. Sie definiert zwei Eigenschaften, die vom Entwickler im Ereignis OnExportFilterSetup angepasst werden können:

  • BandTypes: TfrBandTypes. this is a set of band types, only bands included in this set are actually exported, the rest of bands present on report will be ignored. Using this property a developer could for example export only the master band content, leaving titles, headers and footers out of exported output by doing:
sender.BandTypes := [btMasterData];

by default, all bands are processed but TfrCSVExportFilter changes this property to process only master header, column header and master data bands.

  • UseProgressbar: boolean. Mit dieser Eigenschaft lässt sich die Anzeige eines Fortschrittsbalkens aktivieren oder deaktivieren, der den Fortschritt des Exportprozesses zeigt. Per Vorgabe ist die Eigenschaft auf false gesetzt.

TfrTextExportFilter

Vererbung: TfrExportFilter <- TfrTextExportFilter
befindet sich in der Datei: lr_e_txt.pas, die zum LazReport Package gehört.

is the base class of text based export filters. This export filter tries to make a text representation of a graphical report by fitting the original graphical coordinates into a more coarse grid where each unit is of "UsedFont" pixels, depending on the value of UsedFont value, the exported output may more or less represent the layout of objects in graphical report. Beside the properties inherited from TfrExportFilter class, TfrTextExportFilter define two more properties.

  • UsedFont:integer. this property define the pixel dimensions on the output grid, objects on report are fitted into this grid by reclaculating each x and y position. The default value is 10, if user changes this value to 0 o less, LazReport will show automatically a dialog asking for the UsedFont value, if user enter a invalid value, a 10 value will be used. The 10 value is used because is the value that better fits the usual reports which are made with fonts 10-13 points.
  • UseBOM:boolean. Diese Eigenschaft ermöglicht die Einbeziehung eines UTF-8 Byte Order Mark Zeichens am Beginn der Textausgabe (siehe BOM), das von einigen Editoren/Betrachtern benötigt wird. Per Vorgabe wird BOM in der exportierten Ausgabe nicht verwendet.

TfrCSVExportFilter

Vererbung: TfrExportFilter <- TfrTextExportFilter <- TfrCSVExportFilter
befindet sich in der Datei: lr_e_csv.pas, die zum Package "LazReport" gehört.

Dieser spezielle Text-Exportfilter erzeugt eine Ausgabe von Komma-separierten Werte (Comma Separated Value). Aktuell kann jedes Zeichen als Separator verwendet werden (wobei dies nicht bedeutet, dass das auch sinnvoll ist). it differs from it's ancestor in that it doesn't try to create text layout representation of graphical report, instead, for each record output it tries to guess the fields order from the source report, it then produce a list of fields using a separator defined by the user. Beside the properties inherited from its ancestor classes it defines some properties to customize the generated output.

  • QuoteType:TfrQuoteType. This property controls whether the generated field value should be wrapped using specified quote char or not. Mögliche Werte sind qtNone, qtQuoteChar und qtAutoQuote. With qtNone the field value is never wrapped, qtQuoteChar will use the character specified by property QuoteChar, any instance of QuoteChar already present in field value is duplicated. qtAutoQuote first try to find if any instance of separator or QuoteChar is already present in field value, if affirmative it behaves as if qtQuoteChar has been specified, on the contrary case, the field value is not wrapped just as if qtNone has been specified. QuoteType property is set to qtQuoteChar by default.
  • QuoteChar:TUTF8Char. This holds the character to be used to wrap the field value in case of QuoteType of value qtQuoteChar has been specified or deduced if qtAutoQuote is set. Any instance of this character in the field value will be duplicated. by default QuoteChar is set to the " character.
  • Separator:TUTF8Char. Dieses Zeichen wird verwendet, um die Felder in jedem Datensatz zu separieren. Per Vorgabe wird das Komma (',') verwendet. Es kann aber auch jedes adere gültige UTF-8 Zeichen verwendet werden. Einige CSV Dateien verwenden das TAB Zeichen zum Separieren. Um dies zu erreichen, setzen sie Separator:=#9 ein.

The CSV exporter do not use the inherited UsedFont property value so any value set will be ignored. With default property values, TfrCSVExportFilter will produce Excel compatible files, the only caveat is that Excel will not recognize the file as UTF-8 encoded. To force Excel to recognize the encoding automatically, set the property UseBOM to true.

TfrHTMExportFilter

Vererbung: TfrExportFilter <- TfrTextExportFilter <- TfrHTMExportFilter.
befindet sich in der Datei: lr_e_htm.pas, die zum Package "LazReport" gehört.

Dieser spezielle Text-Exportfilter erzeugt eine gültige "HTML 4.01 Transitional" Ausgabe. Gegenwärtig definiert er nur eine zusätzliche Eigenschaft:

  • UseCSS:boolean. Diese Eigenschaft bestimmt, ob die erzeugte Ausgabe CSS Informationen enthält oder nicht. Sie ist per Vorgabe auf false gesetzt.

TfrImageExportFilter und TfrHtmlDivExportFilter

Für die Verwendung dieser beiden Filter muß das Package lr_extexp installiert werden. Man findet es im addons Unterverzeichnis von LazReport.

PDF-Exportfilter

Um einen Report ins PDF-Format exportieren zu können, muß das Package LazReportPDFExport installiert werden. Man findet es im addons Unterverzeichnis von LazReport. Dieses Package wiederum setzt PowerPDF voraus, welches daher zuerst installiert werden sollte. Nach der Installation kann der neue Exportfilter wie einer der anderen Exportfilter verwendet werden.

Schnellstart

Report Records from a Dataset

In this sample we will design a report to print records from a dataset derived component (TDbf, TSQLQuery, TZTable, TZQuery, etc.). Dabei wird davon ausgegangen, dass LazReport bereits installiert ist und die Komponente "dataset", hier "Dbf1" genannt, bereits konfiguriert und aktiv ist.

  1. Vom LazReport Tab wählen sie eine TfrReport Komponente und legen diese auf dem Formular ab, sie erhält den Namen "frReport1".
  2. Drop a TfrDbDataset component, sie erhält den Namen "frDbDataset1"
  3. Drop a TButton, it will be named Button1, change it's name to "btnShowReport"
  4. With frDbDataset1 selected in Object Inspector select "Dbf1" for the "Dataset" property
  5. Now select frReport1 and using the same procedure link it's "Dataset" property to "frDbDataset1":

    lrformsetup.png

  6. Right Click frReport1 and select "Design Report" from the menu, LazReport report designer will appear.
  7. From Designer window, select menu Tools->Tools->Insert DB Fields, Insert fields Dialog will appear.
  8. In der Liste mit den Feldern wählen sie die Felder, die sie im Report verwenden möchten.
  9. Aktivieren sie die Optionen "Include Headers" und "Include Bands". Das Ergebnis sollte etwa so aussehen:

    lrinsertfieldsdialog.png

  10. Klicken sie auf "Ok" und LazReport wird die Bänder und Felder etwa so anordnen:

    lrreportwithfields.png

  11. Klicken sie auf den Vorschau Button lrprevieweye.png, LazReport wird dann die Daten zusammenführen und etwa so anzeigen:

    lrpreviewreport.png

  12. Speichern sie den Report über das Menü: Datei -> Speichern. Wählen sie das selbe Verzeichnis wie für das aktuelle Projekt und benennen sie den Report listing1.lrf .
  13. Schließen sie den Report-Designer.
  14. Klicken sie doppelt auf btnShowReport und geben sie in der Prozedur den folgenden Code ein:
  frReport1.LoadFromFile('listing1.lrf');
  frReport1.ShowReport;

Bug Reports

Bitte melden sie Probleme und Fehler mittels des lazarus/freepascal Bugtrackers. Wählen sie dort unter project: "Lazarus Packages" und als Category "LazReport". Für Patches erstellen sie bitte einen Bug Report und hängen dort den Patch an.