For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create

Create PDF document from given content.

Task version: 2.2.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.Pdf/

Task Parameters

Name
Description

Directory : String

PDF document destination Directory.

Default: C:\Output Example: F:\outputfiles

FileName : String

Filename for created PDF file.

Default: example_file.pdf Example: output.pdf

FileExistsAction : FileExistsActionEnum

What to do if destination file already exists.

Possible values:

  • Error: What to do if destination file already exists.

  • Overwrite: What to do if destination file already exists.

  • Rename: What to do if destination file already exists.

Default: 0 Example: Error

Name
Description

Title : String

Optional PDF document title.

Default: - Example: Very important document.

Author : String

Optional PDF document Author.

Default: - Example: Erik Example

Size : PageSizeEnum

Document page size.

Possible values:

  • A0: Document page size.

  • A1: Document page size.

  • A2: Document page size.

  • A3: Document page size.

  • A4: Document page size.

  • A5: Document page size.

  • A6: Document page size.

  • B5: Document page size.

  • Ledger: Document page size.

  • Legal: Document page size.

  • Letter: Document page size.

Default: 4 Example: A4

Orientation : PageOrientationEnum

Page orientation.

Possible values:

  • Portrait: Page orientation.

  • Landscape: Page orientation.

Default: 0 Example: Portrait

MarginLeftInCm : Double

Page margin left in CM.

Default: 2.5 Example: 2.5

MarginTopInCm : Double

Page margin top in CM.

Default: 2 Example: 2

MarginRightInCm : Double

Page margin right in CM.

Default: 2.5 Example: 2.5

MarginBottomInCm : Double

Page margin bottom in CM.

Default: 2 Example: 2

Name
Description

Contents : PageContentElement[]

Document content.

Default: - Example: Array of PageContentElements

Name
Description

ThrowErrorOnFailure : Boolean

True: Throws error on failure

False: Returns an object{ Success = false }

Default: True Example: true

CustomFontsLocation : String

Path to a directory with fonts to use.

If empty, a task will use default system locations

Otherwise, CustomFontsLocation will be used as well as default system locations, unless it does not exist.

Default: - Example: C:\MyDir\fonts

FallbackFontName : String

Font family name that will be used if a specific font couldn't be resolved.

This font will be used as an ErrorFontName as well.

Using bundled Victor Mono font if nothing is provided.

Default: - Example: Arial

Task Result

Name
Description

Success : Boolean

Indicates if the operation was successful. Example: true

FileName : String

Name of the file which was created. Example: C:\tmp\example_file.pdf

Task Changelog

Changelog for Task Frends.Pdf.Create.

[2.2.0] - 2026-05-28

Changed

  • Removed outdated Linux package requirements from the documentation

[2.1.0] - 2026-05-06

Fixed

  • Fallback font is now used as an error font as well.

  • Add bundled font to use in case any other font can't be resolved.

[2.0.0] - 2026-02-03

Changed

  • [Breaking Change] Upgrade to .net8.0

  • [Breaking Change] Remove the deprecated option to choose Unicode vs. ANSI text (Code is always Unicode now)

Added

  • Add an option to set up a custom fonts directory

  • Add an option to set up the default font

  • Add support for Linux systems

Fixed

  • Resolve issues with not responsive Windows GDI methods (Failing to get fonts)

[1.2.0] - 2026-02-03

Changed

  • Rename task prefix from PDF to Pdf

[1.1.0] - 2024-08-23

Changed

  • Updated the Newtonsoft.Json package to version 13.0.3.

[1.0.1] - 2023-03-01

Fixed

  • Fixed document link to task portal.

  • Added requirements to the summary.

[1.0.0] - 2022-05-10

Added

  • Initial implementation of Frends.PDF.Create.

Last updated

Was this helpful?