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 PdfFlowOptionsConstructors
| Name | Description |
|---|---|
| PdfFlowOptions() |
PdfFlowOptions()
PdfFlowOptions.cspublic PdfFlowOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| CreateOutline | Gets a value indicating whether the headings are added to the outline (the bookmarks). The default is true. |
| Font | 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. |
| FontSize | Gets the font size of the text, in points. The default is 11. |
| Footer | Gets 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. |
| Header | Gets 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. |
| HeadingFont | Gets the font of the headings, or null for Helvetica Bold when PdfFlowOptions.Font is Helvetica, and PdfFlowOptions.Font otherwise. |
| Language | Gets the natural language of the document (PdfDocument.Language), such as en-US, which PDF/UA requires. |
| LineHeight | Gets the height of the lines, as a multiple of the font size. The default is 1.25. |
| MarginBottom | Gets the bottom margin, in points. The default is 72. |
| MarginLeft | Gets the left margin, in points. The default is 72 (one inch). |
| MarginRight | Gets the right margin, in points. The default is 72. |
| MarginTop | Gets the top margin, in points. The default is 72. |
| PageSize | Gets the size of the pages. The default is A4. |
| ParagraphSpacing | Gets the space after a paragraph, a list, an image or a table, in points. The default is 8. |
| Tagged | 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. |
| TextColor | Gets the color of the text. The default is black. |
| Title | Gets the title of the document (PdfDocumentInformation.Title), which PDF/UA requires. |
CreateOutline
PdfFlowOptions.csFontSize
PdfFlowOptions.csGets the font size of the text, in points. The default is 11.
public double FontSize { get; init; }Header
PdfFlowOptions.csGets 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.
Property value
HeadingFont
PdfFlowOptions.csGets 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
Language
PdfFlowOptions.csGets the natural language of the document (PdfDocument.Language), such as en-US, which PDF/UA requires.
public string? Language { get; init; }Property value
LineHeight
PdfFlowOptions.csGets the height of the lines, as a multiple of the font size. The default is 1.25.
public double LineHeight { get; init; }MarginBottom
PdfFlowOptions.csMarginLeft
PdfFlowOptions.csMarginRight
PdfFlowOptions.csMarginTop
PdfFlowOptions.csPageSize
PdfFlowOptions.csParagraphSpacing
PdfFlowOptions.csTagged
PdfFlowOptions.csTextColor
PdfFlowOptions.csTitle
PdfFlowOptions.csGets the title of the document (PdfDocumentInformation.Title), which PDF/UA requires.
public string? Title { get; init; }