FastReport Documentation

FastReport is an open-source, band-oriented report generator for .NET 6, .NET Core, and .NET Framework. It is compatible with .NET Standard 2.0 and higher.

Key Capabilities:

• Band-Oriented Design: Supports 13 band types (e.g., Report Title, Page Header, Data, Group Header, etc.) for complex layouts like master-detail or multi-column reports.
• Rich Object Set: Includes text, picture, line, shape, barcode, matrix, table, and checkbox objects.
• Data Integration: Connects to XML, CSV, JSON, MS SQL, MySQL, Oracle, Postgres, MongoDB, Couchbase, RavenDB, and SQLite. It also supports IEnumerable business objects.
• Internal Scripting: Includes a built-in engine supporting C# and VB.NET for complex data handling within reports.
• Report Inheritance: Allows creating a base report with common elements (logos, footers) and inheriting them in other reports.

The project follows a standard structure where specific files are required for the build to function:

• public/index.html: The page template.
• src/index.js: The JavaScript entry point.

Important constraints:

• All JS and CSS files must be placed inside the src directory for Webpack to process them.
• Only files inside the public folder can be referenced directly from public/index.html.
• You can create top-level directories for non-production items like documentation, but they will not be included in the production build.

my-app/
  README.md
  node_modules/
  package.json
  public/
    index.html
    favicon.ico
  src/
    App.css
    App.js
    App.test.js
    index.css
    index.js
    logo.svg

This project uses ES6 modules. While require() is supported, it is recommended to use import and export.

Default Exports: Use when a module exports a single entity (e.g., a component).

Named Exports: Use for utility modules exporting multiple functions.

Example of importing a component:

// Button.js
import React, { Component } from 'react';

class Button extends Component {
  render() {
    // ...
  }
}

export default Button;

// DangerButton.js
import React, { Component } from 'react';
import Button from './Button';

class DangerButton extends Component {
  render() {
    return <Button color="red" />;
  }
}

export default DangerButton;

To use SQLite as a data source in FastReport, you must register the SQLiteDataConnection type with the FastReport utility system once during your application's startup sequence. This enables the Designer and the report engine to recognize SQLite connections.

FastReport.Utils.RegisteredObjects.AddConnection(typeof(SQLiteDataConnection));

To deploy to GitHub Pages, follow these steps:

1. Add homepage to package.json:

   "homepage": "https://myusername.github.io/my-app"

2. Install gh-pages and add scripts:

   npm install --save gh-pages

   In package.json, add these to your scripts:

   "predeploy": "npm run build",
   "deploy": "gh-pages -d build"

3. Deploy:

   npm run deploy

4. Configure GitHub Settings: Ensure your GitHub project settings use the gh-pages branch for Pages.

Note on Routing: GitHub Pages does not support the HTML5 pushState API. To use client-side routing, you must either use hashHistory in your router or use a workaround like a 404.html redirect.

React Styleguidist provides a style guide and an environment for developing components in isolation using Markdown examples.

1. Install the package: npm install --save react-styleguidist (or yarn add react-styleguidist)
2. Add the following scripts to your package.json:
   • styleguide: styleguidist server
   • styleguide:build: styleguidist build
3. Run the styleguide server: npm run styleguide

   "scripts": {
+    "styleguide": "styleguidist server",
+    "styleguide:build": "styleguidist build",
     "start": "react-scripts start",
 }

To enable RavenDB as a data source in FastReport, you must register the RavenDBDataConnection type at application startup. This allows the connection to be recognized by the Report Designer and the report engine.

FastReport.Utils.RegisteredObjects.AddConnection(typeof(RavenDBDataConnection));

To use Firebird as a data source in FastReport, you must first register the Firebird connection type at application startup. Once registered, you can programmatically create a FirebirdDataConnection, configure its connection string, and add it to the report's dictionary.

// 1. Execute this once at application start
FastReport.Utils.RegisteredObjects.AddConnection(typeof(FirebirdDataConnection));

// 2. Create and add the connection to your report
Report report = new Report(); 
report.Load(@"YourReport.frx");

FirebirdDataConnection conn = new FirebirdDataConnection();
conn.ConnectionString = "connection string";
conn.CreateAllTables();
report.Dictionary.Connections.Add(conn);

To define environment variables for the duration of a single shell session, use the following commands depending on your operating system:

// Windows (cmd.exe)
set REACT_APP_SECRET_CODE=abcdef&&npm start

# Linux, macOS (Bash)
REACT_APP_SECRET_CODE=abcdef npm start

The production build is a Progressive Web App by default. You can manage service worker behavior in src/index.js.

Opting Out of Caching

To disable service workers before your initial production deployment, remove the call to registerServiceWorker() from src/index.js.

Disabling Service Workers for Existing Users

To uninstall a service worker from users who already have it enabled, modify your service worker import in src/index.js to use unregister instead of register:

import { unregister } from './registerServiceWorker';
// ... call unregister() instead of registerServiceWorker()

Note: Depending on your server configuration, it may take up to 24 hours for the cache to be invalidated.

To use MySQL as a data source in FastReport, you must register the MySqlDataConnection type at application startup. This allows the connection type to be recognized by the Report Designer and the report engine.

FastReport.Utils.RegisteredObjects.AddConnection(typeof(MySqlDataConnection));