LazReport

https://wiki.freepascal.org/LazReport_Documentation
Admin
LazReport is a group of components for adding reporting capabilities to Lazarus applications with a...
Tokens:4,318
Snippets:55
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Scripting Language Example (Nested If)

Source: https://wiki.freepascal.org/LazReport_Documentation

Demonstrates correct syntax for nested if statements in the LazReport scripting language. Ensure semicolons terminate each line.

```pascal
if [[PAY]>0] then begin
 if[[LATE_FEE]=1] then Text:=[MSGL2];
 else Text:= [MSGL1];
 end;
```

--------------------------------

### LazReport Samples

Source: https://wiki.freepascal.org/LazReport_Documentation

Information on where to find example usage of LazReport.

```APIDOC
## LazReport Samples

### Description
Examples demonstrating the usage of LazReport can be found in your Lazarus installation directory.

### Location
`components\lazreport\samples`
```

--------------------------------

### Scripting Language Example (Corrected Nested If)

Source: https://wiki.freepascal.org/LazReport_Documentation

Shows the corrected syntax for nested if statements in the LazReport scripting language, avoiding compilation errors. Semicolons are required at the end of each line.

```pascal
if[[LATE_FEE]=1] then Text:=[MSGL2]
 else Text:= [MSGL1];
```

--------------------------------

### Load and Show Report in LazReport

Source: https://wiki.freepascal.org/LazReport_Documentation

This code snippet demonstrates how to load a report definition from a file and display it using LazReport. Ensure the report file ('listing1.lrf') exists.

```pascal
frReport1.LoadFromFile('listing1.lrf');
frReport1.ShowReport;
```

--------------------------------

### Define Custom Function Template

Source: https://wiki.freepascal.org/LazReport_Documentation

Use this template to define custom functions in the FR.lng file. Specify the function name, category, parameter layout, and a help description.

```pascal
SQRT = Mathematics and Trigonometry|SQRT(<X>)|Returns the square root of <X>
```

```pascal
POS = Strings|POS(<X>,<Y>) Returns the position of string <X> within string <Y>
```

--------------------------------

### LazReport Custom Function Implementation

Source: https://wiki.freepascal.org/LazReport_Documentation

Implement custom functions by creating a TfrOGFunctionLibrary class. Register functions in the constructor and handle their logic in the DoFunction method. Ensure necessary units like FR_Pars and FR_Class are included.

```pascal
Unit FR_OGFct;

interface 

implementation 

uses FR_Pars, FR_Class; // Standard declarations needed for Lazreport!! Note: FR_pars etc? Are these names ok?

type 
  // Our own functions are declared here.
  TfrOGFunctionLibrary = class(TfrFunctionLibrary)
  public  
    constructor Create; override;  
    procedure DoFunction(FNo:integer procedure;  p1, p2,
             p3:Variant; var valley:string); override;  
             p3:Variant; var valley:string);
  end;  

//************************** 
// * TfrOGFunctionLibrary 
constructor TfrOGFunctionLibrary.Create;
begin  
  inherited Create;  
  // Add our functions to the list of available functions:
  with List do 
  begin
    Add('POS');
    Add('SQRT');
  end;
end;

Procedure TfrOGFunctionLibrary.DoFunction(FNo:Integer procedure;  
p1, p2, p3:Variant; Var valley:String); //valley?
Var 
  Par1, Par2:  Varying;
  Result:  Variantying; //variantying? variant?
begin
  Try
    Case FNo of  //this is the index of the functions as added in the constructor
      0 : 
        begin   // POS  function
          Par1:=VarToStr(Parser.Calc(p1)); 
          Par2:=VarToStr(Parser.Calc(P2)); 
          Result:=Pos(Par1,Par2);
        end;
      1 :  // SQRT function
        Result:=SQRT(Parser.Calc(P1));
    end;
  Except   
    // String with error details
    Result:='Error in function '+List.Strings[FNo];
  end;
  Val:=VarToStr(Result); // Resulting string
end;

Procedure DoInit;
begin
  frRegisterFunctionLibrary(TfrOGFunctionLibrary);
end;

```

--------------------------------

### Customizing export filter parameters

Source: https://wiki.freepascal.org/LazReport_Documentation

Use the OnExportFilterSetup event to modify filter-specific properties by type-casting the sender.

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

--------------------------------

### Date and Time Functions

Source: https://wiki.freepascal.org/LazReport_Documentation

Functions for formatting and parsing date and time values based on the current locale.

```text
FORMATDATETIME(<X>, <Y >)
```

```text
FORMATFLOAT(<X>, <Y >)
```

```text
STRTODATE(<X >)
```

```text
STRTOTIME(<X >)
```

--------------------------------

### Calculate Running Total in LazReport

Source: https://wiki.freepascal.org/LazReport_Documentation

Use this script in the text object editor to calculate a running total for a field. Replace '[Dbf1."MTH_NO"]' with your actual field name.

```pascal
IF [Line#] = 1 then RunTotal := [Dbf1."MTH_NO"]
 else RunTotal := RunTotal +[Dbf1."MTH_NO"];
```

--------------------------------

### LazReport Scripting Language

Source: https://wiki.freepascal.org/LazReport_Documentation

Information about the simple scripting language interpreter included in LazReport.

```APIDOC
## LazReport Scripting Language

### Description
A simple scripting language interpreter, similar to Pascal, is included in LazReport.

### Notes
- The interpreter expects semicolons after each line.
- The interpreter does not support nested if statements.

### Examples

**Invalid (nested if):**
```pascal
 if [[PAY]>0] then begin
 if[[LATE_FEE]=1] then Text:=[MSGL2];
 else Text:= [MSGL1];
 end;
```

**Valid (no nested if):**
```pascal
 if[[LATE_FEE]=1] then Text:=[MSGL2]
 else Text:= [MSGL1];
```
```

--------------------------------

### Exporting a report programmatically

Source: https://wiki.freepascal.org/LazReport_Documentation

Use the ExportTo method of a TfrReport instance to save a report to a specific format.

```Pascal
  if TheReport.PrepareReport then
    TheReport.ExportTo(TfrHTMExportFilter, 'exportedfile.html');
```

--------------------------------

### Statistical Functions

Source: https://wiki.freepascal.org/LazReport_Documentation

Functions for performing calculations on data fields.

```text
SUM(<X >)
```

```text
AVG(<X >)
```

```text
COUNT
```

```text
MIN(<X >)
```

```text
MAX(<X >)
```

--------------------------------

### Logical Function

Source: https://wiki.freepascal.org/LazReport_Documentation

Conditional evaluation function.

```text
IF(<X>, <Y>, <Z>)
```

--------------------------------

### TfrHTMExportFilter

Source: https://wiki.freepascal.org/LazReport_Documentation

An export filter that generates valid HTML 4.01 Transitional output.

```APIDOC
## TfrHTMExportFilter

### Description
This special text export filter produces valid "HTML 4.01 Transitional" output.

### Properties
- **UseCSS** (boolean) - Controls whether the produced HTML output includes CSS information. Defaults to true.

### Inheritance
TfrExportFilter <- TfrTextExportFilter <- TfrHTMExportFilter

### Located In
components/lazreport/source/lr_e_htm.pas
```

--------------------------------

### String Manipulation Functions

Source: https://wiki.freepascal.org/LazReport_Documentation

Functions for modifying and extracting substrings from text.

```text
LOWERCASE(<X >)
```

```text
UPPERCASE(<X >)
```

```text
NAMECASE(<X >)
```

```text
COPY(<X>, <Y>, <Z >)
```

--------------------------------

### Numeric Functions

Source: https://wiki.freepascal.org/LazReport_Documentation

Functions for mathematical operations on numeric values.

```text
FRAC(<X >)
```

```text
INT(<X >)
```

```text
ROUND(<X >)
```

```text
STR(<X >)
```

--------------------------------

### Filtering exported bands

Source: https://wiki.freepascal.org/LazReport_Documentation

Modify the BandTypes property within the OnExportFilterSetup event to restrict which report bands are included in the output.

```Pascal
sender.BandTypes := [btMasterData];
```

--------------------------------

### TfrTextExportFilter

Source: https://wiki.freepascal.org/LazReport_Documentation

Base class for text-based export filters. It attempts to represent graphical reports in a text format by fitting objects into a grid based on font size.

```APIDOC
## TfrTextExportFilter

### Description
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. The exported output's fidelity to the original layout depends on the UsedFont value.

### Properties
- **UsedFont** (integer) - Defines the pixel dimensions of the output grid. Objects are fitted into this grid by recalculating their positions. Default is 10. If set to 0 or less, a dialog prompts for the value. An invalid user input defaults to 10. The default value of 10 is suitable for reports made with fonts of 10-13 points.
- **UseBOM** (boolean) - Enables the inclusion of the UTF-8 Byte Order Mark (BOM) at the beginning of the text output. This is needed by some editors/viewers. Defaults to false (no BOM).

### Inheritance
TfrExportFilter <- TfrTextExportFilter

### Located In
components/lazreport/source/lr_e_txt.pas
```

--------------------------------

### TfrCSVExportFilter

Source: https://wiki.freepascal.org/LazReport_Documentation

A specialized text export filter that produces Comma Separated Value (CSV) output. It allows customization of the field separator and quoting behavior.

```APIDOC
## TfrCSVExportFilter

### Description
This special text export filter produces Comma Separated Value output, allowing any character to be used as a separator. It differs from its ancestor by not attempting to create a text layout representation. Instead, it guesses the field order from the report source for each record and produces a list of fields using a user-defined separator.

### Properties
- **QuoteType** (TfrQuoteType) - Controls whether generated field values are wrapped with a specified quote character. Possible values: _qtNone_ (never wrapped), _qtQuoteChar_ (wrapped using **QuoteChar**, existing instances of **QuoteChar** are duplicated), _qtAutoQuote_ (wrapped if the field value contains the separator or **QuoteChar**, otherwise not wrapped). Defaults to _qtQuoteChar_.
- **QuoteChar** (TUTF8Char) - The character used to wrap field values when **QuoteType** is _qtQuoteChar_ or _qtAutoQuote_. Any instance of this character within the field value is duplicated. Defaults to the double quote (").
- **Separator** (TUTF8Char) - The character used to separate fields in each record. Defaults to ',' (comma). Any valid UTF-8 character can be used (e.g., #9 for tab).
- **UseBOM** (boolean) - When set to true, forces Excel to recognize the file as UTF-8 encoded by including the UTF-8 BOM. Defaults to false.

### Notes
- The CSV exporter ignores the inherited **UsedFont** property.
- With default property values, TfrCSVExportFilter produces Excel-compatible files, though Excel may not automatically recognize the encoding as UTF-8 without **UseBOM** set to true.

### Inheritance
TfrExportFilter <- TfrTextExportFilter <- TfrCSVExportFilter

### Located In
components/lazreport/source/lr_e_csv.pas
```
Tokens:
Raw