TMS FlexCel Documentation

website·Indexed 35 days ago

https://doc.tmssoftware.com/flexcel/vcl/

Technical documentation for the FlexCel engine, including the VCL API. Covers classes such as TExcelFile and TFlexCelPdfExport, the IExcelChart interface, and the TXlsFile class for managing Excel files, sheets, styles, and object properties.

Tokens
1.1M
Snippets
7.4K
Records
10.3K
Agent score
59%

What's inside FlexCel

  1. Overview of TDrawingTextParagraph

    TDrawingTextParagraph is an immutable record in the FlexCel.Core unit that represents a paragraph of text located inside a drawing. Because it is immutable, methods that modify the paragraph (such as ReplaceRun or WithNewFieldIds) return a new instance of the record rather than modifying the existing one.
    TDrawingTextParagraph = record;
  2. Overview of the FlexCel.Render namespace

    The FlexCel.Render namespace provides the rendering engine used to convert Excel files (.xls or .xlsx) into other formats, specifically images, PDF, or HTML. It contains the necessary classes, interfaces, and types required to facilitate the export process, including specialized components like TPartialExportState for managing partial file exports.
  3. Overview of TMS Smart Setup

    TMS Smart Setup is a cross-platform installation tool for TMS libraries and components supporting Delphi, C++ Builder, Lazarus/FPC, and .NET. It operates on Windows, Mac, and Linux and does not require administrative permissions for installation. It provides both a GUI and a command-line interface, with the command-line interface being the recommended method for full control and CI/CD automation.
  4. Overview of the FlexCel.Report Namespace

    The FlexCel.Report namespace provides the core reporting engine for FlexCel. It is primarily used to implement the TFlexCelReport class, which enables the creation of Excel reports based on templates. The engine reads an .xls file, replaces defined tags with data sourced from a database or memory, and saves the result as a new file.
  5. Overview of FlexCel Reporting Architecture

    FlexCel provides a high-level templating system using TFlexCelReport that separates report generation into three layers. This allows visual design in Excel without requiring application recompilation for layout or style changes.

    • Data Layer: Contains the data model (databases, in-memory lists, etc.).
    • Interface Layer: Acts as the glue, preparing data for the presentation layer.
    • Presentation Layer: The Excel template where visual aspects (fonts, colors, positions) are defined.

    Data Flow: The flow is pull-based. The Presentation layer requests data from FlexCel, which then retrieves it from the Data layer.

  6. Overview of FlexCel for VCL User Guides

    FlexCel for VCL provides a set of conceptual guides to help developers use the product effectively. Key areas covered include installation, API-based Excel manipulation, template-based report generation using TFlexCelReport, performance optimization, and exporting to PDF and HTML. For detailed technical specifications of every type and method, refer to the API Documentation.
  7. Overview of TMS Smart Setup

    TMS Smart Setup is a tool used to install libraries and components for Delphi, C++ Builder, Lazarus/FPC, and .NET. It supports Windows, Mac, and Linux and does not require administrative permissions for installation. It is available as both a GUI tool and a command-line interface (CLI). The CLI is recommended for full control and integration into CI/CD environments.
  8. Overview of the FlexCel.Pdf low-level PDF engine

    The FlexCel.Pdf namespace provides a low-level PDF engine that allows developers to generate PDF files using an API similar to GDI+. While it is used internally by FlexCel.Render to convert .xls and .xlsx files to PDF, it is not dependent on Excel and can be used as a standalone library for PDF creation.
  9. Manage Excel font properties with TFlxFont

    The TFlxFont record in the FlexCel.Core unit is used to encapsulate and define an Excel font. It provides properties to control the visual appearance of text in a spreadsheet.
    var
      MyFont: TFlxFont;
    begin
      MyFont.Name := 'Arial';
      MyFont.Size20 := 200; // 10 points
      MyFont.Color := clRed;
    end;
  10. Export Excel files to PDF using TFlexCelPdfExport

    The TFlexCelPdfExport class, located in the FlexCel.Render unit, is a component used to export Excel files into PDF format. It inherits from TFlexCelObject and provides a set of properties to control PDF generation, including font mapping, compression, and page sizing.
    uses FlexCel.Render;
    
    var
      PdfExport: TFlexCelPdfExport;
    begin
      // Example instantiation
      PdfExport := TFlexCelPdfExport.Create;
    end;
  11. Use TClientAnchor to manage image anchor offsets

    The TClientAnchor record in the FlexCel.Core unit provides information about image anchors. It is primarily used to determine the offset of an image relative to its parent system when the image is part of a group. If the image is not grouped, or is the top-most shape in a group, the ChildAnchor field is null. When ChildAnchor is not null, other values within the TClientAnchor record are ignored.
    TClientAnchor = record;
      ChildAnchor: // Returns the offset on the parent system for the image when grouped
    end;