PdfFlowOptions Class

The options of a flow document (PdfFlowDocument): its pages, its default text style, and the metadata of the document it builds.

public sealed class PdfFlowOptions

Constructors

NameDescription
PdfFlowOptions()

PdfFlowOptions()

PdfFlowOptions.cs
public PdfFlowOptions()

No documentation is available.

Properties

NameDescription
CreateOutlineGets a value indicating whether the headings are added to the outline (the bookmarks). The default is true.
FontGets the font of the text. The default is Helvetica, a standard font that is not embedded: embed a font for PDF/UA and PDF/A, and for the characters beyond WinAnsiEncoding.
FontSizeGets the font size of the text, in points. The default is 11.
FooterGets the function that gives the text of the footer of a page from its number and the number of pages, such as (page, count) => $"{page} / {count}", or null for none. The footer is drawn centered in the bottom margin, as an artifact.
HeaderGets the function that gives the text of the header of a page from its number and the number of pages, or null for none. The header is drawn centered in the top margin, as an artifact.
HeadingFontGets the font of the headings, or null for Helvetica Bold when PdfFlowOptions.Font is Helvetica, and PdfFlowOptions.Font otherwise.
LanguageGets the natural language of the document (PdfDocument.Language), such as en-US, which PDF/UA requires.
LineHeightGets the height of the lines, as a multiple of the font size. The default is 1.25.
MarginBottomGets the bottom margin, in points. The default is 72.
MarginLeftGets the left margin, in points. The default is 72 (one inch).
MarginRightGets the right margin, in points. The default is 72.
MarginTopGets the top margin, in points. The default is 72.
PageSizeGets the size of the pages. The default is A4.
ParagraphSpacingGets the space after a paragraph, a list, an image or a table, in points. The default is 8.
TaggedGets a value indicating whether the document is tagged (14.8): its content is in a structure tree of headings, paragraphs, lists, tables and figures, and the decorations are artifacts. The default is true.
TextColorGets the color of the text. The default is black.
TitleGets the title of the document (PdfDocumentInformation.Title), which PDF/UA requires.

CreateOutline

PdfFlowOptions.cs

Gets a value indicating whether the headings are added to the outline (the bookmarks). The default is true.

public bool CreateOutline { get; init; }

Property value

bool

Gets the font of the text. The default is Helvetica, a standard font that is not embedded: embed a font for PDF/UA and PDF/A, and for the characters beyond WinAnsiEncoding.

public PdfFont Font { get; init; }

Property value

PdfFont

Gets the font size of the text, in points. The default is 11.

public double FontSize { get; init; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not positive.

Gets the font of the headings, or null for Helvetica Bold when PdfFlowOptions.Font is Helvetica, and PdfFlowOptions.Font otherwise.

public PdfFont? HeadingFont { get; init; }

Property value

PdfFont?

Gets the natural language of the document (PdfDocument.Language), such as en-US, which PDF/UA requires.

public string? Language { get; init; }

Property value

string?

Gets the height of the lines, as a multiple of the font size. The default is 1.25.

public double LineHeight { get; init; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not positive.

MarginBottom

PdfFlowOptions.cs

Gets the bottom margin, in points. The default is 72.

public double MarginBottom { get; init; }

Property value

double

Gets the left margin, in points. The default is 72 (one inch).

public double MarginLeft { get; init; }

Property value

double

Gets the right margin, in points. The default is 72.

public double MarginRight { get; init; }

Property value

double

Gets the top margin, in points. The default is 72.

public double MarginTop { get; init; }

Property value

double

Gets the size of the pages. The default is A4.

public PdfSize PageSize { get; init; }

Property value

PdfSize

ParagraphSpacing

PdfFlowOptions.cs

Gets the space after a paragraph, a list, an image or a table, in points. The default is 8.

public double ParagraphSpacing { get; init; }

Property value

double

Gets a value indicating whether the document is tagged (14.8): its content is in a structure tree of headings, paragraphs, lists, tables and figures, and the decorations are artifacts. The default is true.

public bool Tagged { get; init; }

Property value

bool

Gets the color of the text. The default is black.

public PdfColor TextColor { get; init; }

Property value

PdfColor

Gets the title of the document (PdfDocumentInformation.Title), which PDF/UA requires.

public string? Title { get; init; }

Property value

string?