QuestPDF

The hot-reload feature and QuestPDF Companion integration are available only in the .NET 6 environment or later. Please consider updating your project. Installation and usage
Features overview

This parameter is ignored.

The hot-reload feature and QuestPDF Companion integration are available only in the .NET 6 environment or later. Please consider updating your project. Installation and usage
Features overview

This parameter is ignored.

Registers a TrueType font from a stream under the provided custom . Refer to this font by using the same name as a font family in the API later on. Learn more

Registers a TrueType font from a stream. The font family name and all related attributes are detected automatically. Learn more

Registers a TrueType font from an embedded resource. The font family name and all related attributes are detected automatically. Learn more

Path to the embedded resource (the case-sensitive name of the manifest resource being requested).

Stores all contextual information available for the dynamic component.

Returns the number of the page being rendered at the moment.

Returns the total count of pages in the document.

Document rendering process is performed in two phases. During the first phase, the value of this property is equal to int.MaxValue to indicate its unavailability. Please note that using this property may result with unstable layouts and unpredicted behaviors, especially when generating conditional content of various sizes.

Returns the vertical and horizontal space, in points, available to the dynamic component.

Returns all page locations of the captured element.

Enables the creation of unattached layout structures and provides their size measurements.

The handler responsible for constructing the new layout structure. A newly created content, with its physical size.

Represents any unattached content element, created by the dynamic component.

Specifies the vertical and horizontal size, measured in points, required by the element to be drawn completely, assuming infinite canvas.

Generates an image based on the given resolution.

Desired resolution of the image in pixels. Desired resolution of the image in dots per inch. An image in PNG, JPEG, or WEBP image format returned as byte array.

The TextBlock element uses SkParagraph cache to enhance rendering speed. This cache uses a significant amount of memory and is cleared after FullRender. However, the MultiColumn element uses a sophisticated measuring algorithm, and may force the Text element to measure/render multiple times per page. To avoid performance issues, the TextBlock element should keep its cache.

The TextBlock element uses SkParagraph cache to enhance rendering speed. This cache uses a significant amount of memory and is cleared after FullRender. However, when using the RepeatContent element, the cache is cleared after each repetition. To avoid performance issues, the default behavior is disabled. Similarly, the Lazy element builds entire content on demand, waits to fully render it and then removes it. This aims to optimize managed memory usage. However, it may not be the most optimal solution in repeating context.

Returns the total count of pages in the document.

Document rendering process is performed in two phases. During the first phase, the value of this property is equal to null to indicate its unavailability. Please note that using this property may result with unstable layouts and unpredicted behaviors, especially when generating conditional content of various sizes.

This dictionary allows to access key that does not exist. Instead of throwing an exception, it returns a default value.

Adjusts the concurrency level for the SkParagraph.PlanLayout method to optimize performance. While the Skia implementation is thread-safe, it appears to contain internal locks that hinder scalability. Consequently, using multithreading for document rendering can reduce performance. This includes increased memory usage and slower generation times—potentially even worse than rendering documents sequentially. TODO: investigate further on how to improve scalability and remove this mutex

Aligns content horizontally to the left side. Learn more

Aligns content horizontally to the center, ensuring equal space on both left and right sides. Learn more

Aligns its content horizontally to the right side. Learn more

Aligns content vertically to the upper side. Learn more

Aligns content vertically to the center, ensuring equal space above and below. Learn more

Aligns content vertically to the bottom side. Learn more

Adjusts vertical spacing between items.

Adds a new item to the column element.

The container of the newly created item.

Draws a collection of elements vertically (from top to bottom). Learn more

Supports paging. The action to configure the column's content.

Components serve as modular building blocks for abstracting document layouts. They promote code reusability across multiple sections or types of documents. Using a component, you can generate content based on its internal state. Learn more

Consider the scenario of a company-wide page header. Instead of replicating the same header design across various documents, a single component can be created and referenced wherever needed. Instance of the class implementing the interface.

Consider the scenario of a company-wide page header. Instead of replicating the same header design across various documents, a single component can be created and referenced wherever needed.

Sets the exact width of its content. Learn more

The container with the specified exact width.

Sets the minimum width of its content. Learn more

The container with the specified minimum width.

Sets the maximum width of its content. Learn more

The container with the specified maximum width.

Sets the exact height of its content. Learn more

The container with the specified exact height.

Sets the minimum height of its content. Learn more

The container with the specified minimum height.

Sets the maximum height of its content. Learn more

The container with the specified maximum height.

Sets the left-to-right (LTR) direction for its entire content. Learn more

This writing system is used by most of modern languages. The content direction affects various layout structures. In LTR mode, items are typically aligned to the left. This mode also influences the direction of items in certain layouts. For instance, in a row element with LTR mode, the first item is positioned on the left, while the last item is on the right.

Sets the right-to-left (RTL) direction for its entire content. Learn more

This writing system is used by languages such as Hebrew, Arabic, and Persian. The content direction affects various layout structures. In RTL mode, items are typically aligned to the right. This mode also influences the direction of items in certain layouts. For instance, in a row element with RTL mode, the first item is positioned on the right, while the last item is on the left.

Draws a labeled box around its inner content. Useful for visual debugging and pinpointing output from specific code blocks.
Learn more

Optional label displayed within the box. Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Inserts a virtual debug element visible in the document hierarchy tree in the QuestPDF Companion App, as well as in the enhanced debugging message provided by the . It helps with understanding and navigation of the document hierarchy. Learn more

This debug element does not appear in the final PDF output. Text visible somewhere in the "element trace" content identifying given document fragment.

Returns a container for the section positioned before (above) the primary main content.

This container is fully visible on each page and does not support paging.

Provides a handler to the section that appears before (above) the main content.

This container is fully visible on each page and does not support paging.

Returns a container for the main section.

This container does support paging.

Provides a handler to define content of the main section.

This container does support paging.

Returns a container for the section positioned after (below) the main content.

This container is fully visible on each page and does not support paging.

Provides a handler to the section that appears after (below) the main content.

This container is fully visible on each page and does not support paging.

Divides the container's space into three distinct sections: before, content, and after. The "before" section is rendered above the main content, while the "after" section is rendered below it. If the main "content" spans across multiple pages, both the "before" and "after" sections are consistently rendered on every page.
Learn more

A typical use-case for this method is to render a table that spans multiple pages, with a consistent caption or header on each page. The action to configure the content.

Provides functionality for performing various operations on PDF documents, including loading, merging, overlaying, underlaying, selecting specific pages, adding attachments, and applying encryption settings.

Represents configuration options for applying an overlay or underlay to a PDF document using qpdf.

The file path of the overlay or underlay PDF file to be used.

Specifies the range of pages in the output document where the overlay or underlay will be applied. If not specified, the overlay or underlay is applied to all output pages.

Syntax Description 1, 2, 3 Plain numbers indicate pages numbered from the start r1, r2 Numbers with 'r' prefix count from the end (r1 = last page) z Represents the last page (equivalent to r1) 1-5 Dash-separated ranges are inclusive 5-1 Reversed ranges list pages in descending order x1-3 Excludes specified pages from previous range :odd Selects odd-positioned pages from the resulting page-set :even Selects even-positioned pages from the resulting page-set Expression Result 1,6,4 pages 1, 6, and 4 in that order 3-7 pages 3 through 7 inclusive 7-3 pages 7, 6, 5, 4, and 3 in that order 1-z all pages in order z-1 all pages in reverse order r3-r1 the last three pages of the document r1-r3 the last three pages of the document in reverse order 1-20:even even pages from 2 to 20 5,7-9,12 pages 5, 7, 8, 9, and 12 5,7-9,12:odd pages 5, 8, and 12 (pages in odd positions from the original set of 5, 7, 8, 9, 12) 5,7-9,12:even pages 7 and 9 (pages in even positions from the original set of 5, 7, 8, 9, 12) 1-10,x3-4 pages 1 through 10 except pages 3 and 4 (1, 2, and 5 through 10) 4-10,x7-9,12-8,xr5 In a 15-page file: pages 4, 5, 6, 10, 12, 10, 9, and 8 in that order (pages 4 through 10 except 7 through 9, followed by 12 through 8 descending, except 11 which is the fifth page from the end)

Specifies the range of pages in the overlay or underlay file to be used initially. If not specified, all pages in the overlay or underlay file will be used in sequence.

Specifies an optional range of pages in the overlay or underlay file that will repeat after the initial source pages are exhausted. Useful for repeating certain pages of the overlay or underlay file across multiple pages of the output.

Indicates data files relevant to the document (e.g., supporting datasets or data tables).

Represents a source file directly used to create the document.

An alternative representation of the document content (e.g., XML, HTML).

A file supplementing the content, like additional resources.

No specific relationship is defined.

Sets the key for the attachment, specific to the PDF format. Defaults to the file name without its path.

The file path of the attachment. Ensure that the specified file exists.

Specifies the display name for the attachment. This name is typically shown to the user and used by most graphical PDF viewers when saving the file. Defaults to the file name without its path.

Specifies the creation date of the attachment. Defaults to the file's creation time.

Specifies the modification date of the attachment. Defaults to the file's last modified time.

Specifies the MIME type of the attachment, such as "text/plain", "application/pdf", "image/png", etc.

Sets a description for the attachment, which may be displayed by some PDF viewers.

Indicates whether to replace an existing attachment with the same key. If false, an exception is thrown if an attachment with the same key already exists.

Specifies the relationship of the embedded file to the document for PDF/A-3b compliance.

The user password for the PDF, allowing restricted access based on encryption settings. May be left null to enable opening the PDF without a password, though this may restrict certain operations.

The owner password for the PDF, granting full access to all document features. An empty owner password is considered insecure, as is using the same value for both user and owner passwords.

Specifies whether the user is permitted to add signatures and annotations to the document.

Specifies whether the user is allowed to copy text and graphics from the document.

Specifies whether the user is permitted to insert, rotate, or delete pages within the document.

Specifies whether the user can print the document.

Specifies whether the user is permitted to add signatures and annotations to the document.

Specifies whether the user is permitted to insert, rotate, or delete pages within the document.

Specifies whether the user is allowed to copy text and graphics from the document.

Specifies whether the user is allowed to fill out existing form fields in the document.

Specifies whether the user can print the document.

Determines whether the document's metadata is included in encryption.

Specifies whether the user is permitted to add signatures and annotations to the document.

Specifies whether the user is permitted to insert, rotate, or delete pages within the document.

Specifies whether the user is allowed to copy text and graphics from the document.

Specifies whether the user is allowed to fill out existing form fields in the document.

Specifies whether the user can print the document.

Determines whether the document's metadata is included in encryption.

Loads the specified PDF file for processing, enabling operations such as merging, overlaying or underlaying content, selecting pages, adding attachments, and encrypting.

The full path to the PDF file to be loaded. The password for the PDF file, if it is password-protected. Optional.

Selects specific pages from the current document based on the provided page selector, marking them for further operations.

Merges pages from the specified PDF file into the current document, according to the provided page selection.

The path to the PDF file to be merged. An optional to specify the range of pages to merge. If not provided, all pages will be merged. Syntax Description 1, 2, 3 Plain numbers indicate pages numbered from the start r1, r2 Numbers with 'r' prefix count from the end (r1 = last page) z Represents the last page (equivalent to r1) 1-5 Dash-separated ranges are inclusive 5-1 Reversed ranges list pages in descending order x1-3 Excludes specified pages from previous range :odd Selects odd-positioned pages from the resulting page-set :even Selects even-positioned pages from the resulting page-set Expression Result 1,6,4 pages 1, 6, and 4 in that order 3-7 pages 3 through 7 inclusive 7-3 pages 7, 6, 5, 4, and 3 in that order 1-z all pages in order z-1 all pages in reverse order r3-r1 the last three pages of the document r1-r3 the last three pages of the document in reverse order 1-20:even even pages from 2 to 20 5,7-9,12 pages 5, 7, 8, 9, and 12 5,7-9,12:odd pages 5, 8, and 12 (pages in odd positions from the original set of 5, 7, 8, 9, 12) 5,7-9,12:even pages 7 and 9 (pages in even positions from the original set of 5, 7, 8, 9, 12) 1-10,x3-4 pages 1 through 10 except pages 3 and 4 (1, 2, and 5 through 10) 4-10,x7-9,12-8,xr5 In a 15-page file: pages 4, 5, 6, 10, 12, 10, 9, and 8 in that order (pages 4 through 10 except 7 through 9, followed by 12 through 8 descending, except 11 which is the fifth page from the end)

Applies an underlay to the document using the specified configuration. The underlay pages are drawn beneath the target pages in the output file, potentially obscured by the original content.

Applies an overlay to the document using the specified configuration. The overlay pages are drawn on top of the target pages in the output file, potentially obscuring the original content.

Extends the current document's XMP metadata by adding content within the rdf:Description tag. This allows for adding additional descriptive metadata to the PDF, which is useful for compliance standards like PDF/A or for industry-specific metadata (e.g., ZUGFeRD).

A string containing the metadata to add. This metadata must be valid XML content and conform to the RDF structure required by the PDF XMP metadata specification.

Adds an attachment to the document, with specified metadata and configuration options.

Removes any existing encryption from the current PDF document, effectively making it accessible without a password or encryption restrictions.

Remove security restrictions associated with digitally signed PDF files. This may be combined with Decrypt() operation to allow free editing of previously signed/encrypted files. This option invalidates and disables any digital signatures but leaves their visual appearances intact.

Encrypts the document using 40-bit encryption, applying specified owner and user passwords along with defined permissions.

Encrypts the document using 128-bit encryption, applying specified owner and user passwords along with defined permissions.

Encrypts the document using 256-bit encryption, applying specified owner and user passwords along with defined permissions.

Creates linearized (web-optimized) output files. Linearized files are structured to allow compliant PDF readers to begin displaying content before the entire file is downloaded. Normally, a PDF reader requires the entire file to be present to render content, as essential cross-reference data typically appears at the file’s end.

Executes the configured operations on the document and saves the resulting file to the specified path.

The path where the output file will be saved.

Represents a dynamically generated section of the document. Components are page-aware, understand their positioning, can dynamically construct other content elements, and assess their dimensions, enabling complex layout creations. Learn more

Consider an invoice that presents all purchased items in a table format. Instead of just showing the final total price under the table, the requirement is to display the cumulative prices on each separate page. Using the dynamic component, you can manually assemble the table, count how many items are visible on each page, calculate the price sum for items visible on each page, and then render the result under each sub-table.

Represents a section of the document dynamically created based on its inner state. Components are page-aware, understand their positioning, can dynamically construct other content elements, and assess their dimensions, enabling complex layout creations. Learn more

Allows to inject the unattached content created by the method within the Dynamic component.

Provides extension methods for manipulating and enhancing elements within a container.

Passes the Fluent API chain to the provided method. Learn more

This method is particularly useful for code refactoring, improving its structure and readability. Extracting implementation of certain layout structures into separate methods, allows you to accurately describe their purpose and reuse them code in various parts of the application. A delegate that takes the current container and populates it with content.

Passes the Fluent API chain to the provided method. Learn more

This method is particularly useful for code refactoring, improving its structure and readability. Extracting implementation of certain layout structures into separate methods, allows you to accurately describe their purpose and reuse them code in various parts of the application. A method that accepts the current container, optionally populates it with content, and returns a subsequent container to continue the Fluent API chain. The container returned by the method.

Constrains its content to maintain a given width-to-height ratio. Learn more

This container enforces strict space constraints. The may be thrown if these constraints can't be satisfied. Represents the aspect ratio as a width-to-height division. For instance, a container with a width of 250 points and a height of 200 points has an aspect ratio of 1.25. Determines the approach the component should adopt when maintaining the specified aspect ratio.

Draws a basic placeholder useful for prototyping. Learn more

You can control the size of the Placeholder by chaining other elements before its invocation, e.g.:


            .Width(200)
            .Height(100)
            .Placeholder("Sample text");

When provided, the placeholder displays this text. If omitted, a simple image icon is shown instead.

The ShowOnce element modifies how content is displayed across multiple pages. By default, all elements are fully rendered only once and never repeated. However, in some contexts such as page headers and footers, as well as decoration before and after slots, the content is repeated on every page. To prevent this, you can use the ShowOnce element. Learn more

Combine this element with SkipOnce to achieve more complex behaviors, e.g.: .SkipOnce().ShowOnce() ensures the child element is displayed only on the second page. .SkipOnce().SkipOnce() starts displaying the child element from the third page onwards. .ShowOnce().SkipOnce() draws nothing, as the order of invocation is important.

If the container spans multiple pages, its content is omitted on the first page and then displayed on the second and subsequent pages. Learn more

A common use-case for this element is when displaying a consistent header across pages but needing to conditionally show/hide specific fragments on the first page. Combine this element with ShowOnce to achieve more complex behaviors, e.g.: .SkipOnce().ShowOnce() ensures the child element is displayed only on the second page. .SkipOnce().SkipOnce() starts displaying the child element from the third page onwards. .ShowOnce().SkipOnce() draws nothing, as the order of invocation is important.

Ensures its content is displayed entirely on a single page by disabling the default paging capability. Learn more

While many library elements inherently support paging, allowing content to span multiple pages, this element restricts that behavior. Employ this when a single-page display is crucial. Be cautious: its strict space constraints can trigger the if content exceeds the page's capacity.

Ensures that the container's content occupies at least a specified minimum height on its first page of occurrence. If there is enough space, the content is rendered as usual. However, if a page break is required, this method ensures that a minimum amount of space is available before rendering the content. If the required space is not available, the content is moved to the next page. This rule applies only to the first page where the content appears. If the content spans multiple pages, all subsequent pages are rendered without this restriction. This method is particularly useful for structured elements like tables, where rendering only a small fragment at the bottom of a page could negatively impact readability. By ensuring a minimum height, you can prevent undesired content fragmentation.
Learn more

The minimum height, in points, that the element should occupy before a page break.

Attempts to keep the container's content together on its first page of occurrence. If the content does not fit entirely on that page, it is moved to the next page. If it spans multiple pages, all subsequent pages are rendered as usual without restriction. This method is useful for ensuring that content remains visually coherent and is not arbitrarily split.
Learn more

Inserts a break that pushes the subsequent content to start on a new page. Learn more

A neutral layout structure that neither contributes to nor alters its content.

By default, certain FluentAPI calls may be batched together for optimized performance. Introduce this element if you wish to separate and prevent such optimizations.

Creates a clickable area that redirects the user to a designated webpage. Learn more

The URL of the webpage to which the user will be redirected.

Defines a named fragment of the document that can span multiple pages. Learn more

Several other elements interact with sections: Use SectionLink to create a clickable area redirecting user to the first page of the associated section. The Text element can display section properties, such as the starting page, ending page, and length. An internal text key representing the section. It should be unique and won't appear in the final document.

Creates a clickable area that navigates the user to a designated section. Learn more

The text key corresponding to the value used when defining the Section element.

Conditionally draws or hides its inner content. Learn more

If the value is , its content is visible. Otherwise, it's hidden.

Conditionally draws or hides its inner content depending on drawing context. Please use carefully as certain predicates may produce unstable layouts resulting with unexpected content or exceptions. Learn more

If the predicate returns , its content is visible. Otherwise, it's hidden.

Removes size constraints and grants its content virtually unlimited space. Learn more

Applies a default text style to all nested Text elements. Learn more

If multiple text elements have a similar style, using this element can help simplify your code. A TextStyle object used to override specific properties.

Applies a default text style to all nested Text elements. Learn more

If multiple text elements have a similar style, using this element can help simplify your code. A handler to modify the default text style.

Renders the element exclusively on the first page. Any portion of the element that doesn't fit is omitted. Learn more

Adjusts its content to fit within the available space by scaling it down proportionally if necessary. Learn more

This container determines the best scale value through multiple scaling operations. With complex content, this may impact performance. Pairing with certain elements, such as AspectRatio, might still lead to a .

Repeats its content across multiple pages. Learn more

In certain layout structures, the content visibility may depend on other elements. By default, most elements are rendered only once. Use this element to repeat the content across multiple pages.

Delays the creation of document content and reduces its lifetime, significantly lowering memory usage in large documents containing thousands of pages. This approach also enhances garbage collection efficiency in memory-constrained environments. The provided delegate is invoked later in the document generation process. For optimal performance, divide your document into smaller sections, each encapsulated within its own Lazy element. Further optimizations can be achieved by nesting Lazy elements within each other. However, note that this technique may increase the overall document generation time due to deferred content processing. Learn more

Functions similarly to the Lazy element but enables the library to use caching mechanisms for the content. This can help optimize managed memory usage, although native memory usage may remain high. Use LazyWithCache only when the increased generation time associated with the Lazy element is unacceptable. Learn more

By default, the library draws content in the order it is defined, which may not always be the desired behavior. This element allows you to alter the rendering order, ensuring that the content is displayed in the correct sequence. The default z-index is 0, unless a different value is inherited from a parent container. Learn more

The z-index value. Higher values are rendered above lower values.

Observes the rendering process of its content and captures its position and size on each page. The captured data can be then used in the Dynamic component to build and position other elements. Learn more

Forces its content to occupy entire available space, maximizing both width and height. Learn more

Forces its content to occupy entire available vertical space, maximizing height usage. Learn more

Expands its content to occupy entire available horizontal space, maximizing width usage. Learn more

Generates the document in PDF format and returns it as a byte array.

Generates the document in PDF format and saves it to the specified file path.

Generates the document in PDF format and outputs it to a provided stream.

Generates the document in PDF format, saves it in temporary file, and then opens it with the default application.

Generates the document in XPS format and returns it as a byte array.

Supported only on the Windows platform.

Generates the document in XPS format and saves it to the specified file path.

Supported only on the Windows platform.

Generates the document in XPS format and outputs it to a provided stream.

Supported only on the Windows platform.

Generates the document in XPS format, saves it in temporary file, and then opens it with the default application.

Supported only on the Windows platform.

Generates the document as a series of images and returns them as a collection of byte arrays.

Optional settings to customize the generation process, such as image resolution, compression ratio, and more. Specifies the index of the generated image from the document, starting at 0. The file path where the image should be saved.

Generates the document as a sequence of images, saving them to paths determined by the delegate.

A delegate that gets image index as an input, and returns file path where it should be saved. Optional settings for fine-tuning the generated images, such as resolution, compression ratio, etc.

Generates the document as a series of SVG images and returns them as a collection of strings.

When enabled, the library does not resize the image to achieve the target DPI, nor compress it with target image quality.

Specifies the DPI (dots-per-inch) for rasterizing images, which is a measure of an image's resolution that indicates how many individual dots (or pixels) fit into one inch of a printed image. Higher DPI values result in greater detail and sharpness, making images appear clearer when printed, while lower DPI values can cause images to look blurry or pixelated. The target resolution is computed by multiplying the DPI with the physical image size on the document. Default DPI value is 288 DPI.

If the image has lower resolution that the one calculated from the DPI setting, it will NOT be rescaled. Consider an image of dimensions 3x4 inches. Using a DPI value of 300, the final resolution translates to 900x1200 pixels.

Controls the balance between an image's file size and its visual fidelity during compression. Higher quality values preserve more detail with larger file sizes, while lower values reduce file size at the cost of potential image degradation, such as blurriness or artifacts. Opaque images are JPEG-encoded based on this setting, while images with an alpha channel default to PNG format, disregarding this option. Default is set to "high quality".

When enabled, the library does not resize the image to achieve the target DPI, nor compress it with target image quality.

Scales the image to fill the full width of its container. This is the default behavior.

The image stretches vertically to fit the full available height. Often used with height-constraining elements such as: Height, MaxHeight, etc.

Combines the FitWidth and FitHeight settings. The image resizes itself to utilize all available space, preserving its aspect ratio. It will either fill the width or height based on the container's dimensions.

An optimal and safe choice.

The image adjusts to fill all the available space, disregarding its original proportions. This can lead to distorted scaling and is generally not recommended for most scenarios.

Draws an image by decoding it from a provided byte array. Learn more

Please note that there is a significant difference between image resolution (number of pixels vertically and horizontally) and its physical size described in points. Therefore, the resolution of an image is not used for determining its physical size on the document. Multiple strategies exist for the Image element to determine its final size. By default, the image fills all the available width. This behavior can be customized using options within the descriptor class. Images are automatically resized and compressed based on the descriptor's setup. It defaults to global document's settings. Supported formats: PNG, JPEG and WEBP. Descriptor allowing adjustments to image attributes, such as scaling behavior, compression quality, and target DPI.

Draws the image loaded from a file located at the provided path. Learn more

Draws the image loaded from a stream. Learn more

Draws the object. Allows to optimize the generation process. Learn more

Renders an image of dynamic size dictated by the document layout constraints.

Ideal for generating pixel-perfect images that might lose quality upon scaling, such as maps or charts. A delegate that requests an image of desired resolution calculated based on target physical image size and provided DPI. A descriptor for adjusting image attributes like scaling behavior, compression quality, and resolution.

Renders an image of dynamic size dictated by the document layout constraints.

Sets the vertical and horizontal gaps between items.

Sets the vertical gaps between items.

Sets the horizontal gaps between items.

Positions items vertically such that their top edges align on a single line.

Positions items to have their centers in a straight horizontal line.

Positions items vertically such that their bottom edges align on a single line.

Aligns items horizontally to the left side.

Aligns items horizontally to the center.

Aligns items horizontally to the left right.

Distributes items horizontally, ensuring even spacing from edge to edge of the container.

Spaces items equally in a horizontal arrangement, both between items and at the ends.

Adds a new item to the container.

The container of the newly created item.

Arranges its items sequentially in a line, wrapping to the next line if necessary. Learn more

Supports the paging functionality. Handler to configure content of this container, as well as spacing and items alignment.

Specifies an additional layer for the container.

The order of code execution determines the drawing order: If the layer is defined before the primary layer, it's drawn underneath the primary content (as a background). If defined after the primary layer, it's drawn in front of the primary content (as a watermark).

Sets the primary content for the container.

Exactly one primary layer should be defined.

Adds content either underneath (as a background) or on top of (as a watermark) the main content. The main layer supports paging, can span multiple pages, and determines the container's target length. Additional layers can also span multiple pages and are repeated on each one. Learn more

Handler for defining content of the container, including exactly one primary layer and any additional layers in a specified order.

Specifies the color for the line.

Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Configures a dashed pattern for the line. For example, a pattern of [2, 3] creates a dash of 2 units followed by a gap of 3 units.

The length of this array must be even.

Applies a linear gradient to a line using the specified colors.

Renders a vertical line with a specified thickness. Learn more

The line is not just a visual element; it occupies actual space within the document. A descriptor to modify line attributes.

Renders a horizontal line with a specified thickness. Learn more

The line is not just a visual element; it occupies actual space within the document. A descriptor to modify line attributes.

Creates a new empty document and provides handler to specify its content.

A Document object with the specified content. This object allows to set metadata, configure generation parameters, and produce output files such as PDF, XPS, or images.

Configures the metadata of the PDF document, such as title, author, keywords, etc.

Enables fine-tuning of the document generation process, influencing attributes of the resulting PDF such as target DPI, image compression, compliance with the PDF/A standard, etc.

Combines multiple documents together into a single one.

A MergedDocument object that allows to set metadata, configure generation parameters, adjust merging strategy, and produce output files such as PDF, XPS, or images.

Combines multiple documents together into a single one.

A MergedDocument object that allows to set metadata, configure generation parameters, adjust merging strategy, and produce output files such as PDF, XPS, or images.

Implements the IDocument interface. Don't use within the Fluent API chain.

Configures the horizontal spacing between adjacent columns in the layout.

This method affects the visual presentation of the column arrangement. Positive values increase separation, while negative values may cause overlap.

Defines the number of vertical columns in the layout.

This method determines the basic structure of the grid layout. Setting this value will redistribute the existing elements across the new column count.

Controls the content distribution across columns to achieve balanced heights.

When enabled: content flow is adjusted to equalize column heights; each column will have approximately the same height. When disabled: layout occupies the full vertical space, the last column may be shorter or empty, depending on content quantity.

Retrieves a container for the primary content to be distributed across multiple columns.

The returned container serves as the main content area for the multi-column layout. It supports all available layout elements and automatically divides its content among the defined columns.

Retrieves a container for content positioned between columns in the layout.

The container's dimensions are determined by the height of the columns and the configured spacing. This container supports all available layout elements, allowing for flexible design of inter-column content.

Creates a multi-column layout within the current container element.

A multi-column layout organizes content into vertical columns, similar to a newspaper or magazine layout. This approach allows for efficient use of horizontal space and can improve readability, especially for wide containers or screens. The content flows from one column to the next, and the number of columns can be adjusted based on the container's width or specific design requirements. The action to configure the column's content and behavior.

For positive values, adds empty space around its content. For negative values, pushes its content beyond the edges, increasing available space, similarly to negative HTML margins.
Learn more

For positive values, adds empty space horizontally (left and right) around its content. For negative values, pushes its content beyond the horizontal edges, increasing available space, similarly to negative HTML margins.
Learn more

For positive values, adds empty space vertically (top and bottom) around its content. For negative values, pushes its content beyond the vertical edges, increasing available space, similarly to negative HTML margins.
Learn more

For positive values, adds empty space above its content. For negative values, pushes its content beyond the top edge, increasing available space, similarly to negative HTML margins.
Learn more

For positive values, adds empty space below its content. For negative values, pushes its content beyond the bottom edge, increasing available space, similarly to negative HTML margins.
Learn more

For positive values, adds empty space to the left of its content. For negative values, pushes its content beyond the left edge, increasing available space, similarly to negative HTML margins.
Learn more

For positive values, adds empty space to the right of its content. For negative values, pushes its content beyond the right edge, increasing available space, similarly to negative HTML margins.
Learn more

Configures the dimensions of every page within the set.

Enables the continuous page size mode, allowing the page's height to adjust according to content while retaining a constant specified .

This configuration is suitable for producing PDFs intended for printing on the paper roll.

Enables the flexible page size mode, where the output page's dimensions can vary based on its content. Specifies the smallest possible page size.

Note that with this setting, individual pages within the document may have different sizes.

Enables the flexible page size mode, where the output page's dimensions can vary based on its content. Specifies the largest possible page size.

Note that with this setting, individual pages within the document may have different sizes.

Adds empty space to the left of the primary layer (header + content + footer).

Adds empty space to the right of the primary layer (header + content + footer).

Adds empty space above the primary layer (header + content + footer).

Adds empty space below the primary layer (header + content + footer).

Adds empty space vertically (top and bottom) around the primary layer (header + content + footer).

Adds empty space horizontally (left and right) around the primary layer (header + content + footer).

Adds empty space around the primary layer (header + content + footer).

Applies a default text style to all Text elements within the page set.

Use this method to achieve consistent text styling across entire document. A delegate to adjust the global text style attributes.

Applies a default text style to all Text elements within the page set.

Use this method to achieve consistent text styling across entire document. A handler to adjust the global text style attributes.

Applies a left-to-right (LTR) content direction to all elements within the page set. Learn more

Applies a right-to-left (RTL) content direction to all elements within the page set. Learn more

Sets a background color of the page, which is white by default.

When working with file formats that support the alpha channel, it is possible to set the color to if necessary. Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Represents a layer drawn behind the primary layer (header + content + footer), serving as a background.

Unaffected by the Margin configuration, it always occupies entire page.

Represents a layer drawn in front of the primary layer (header + content + footer), serving as a watermark.

Unaffected by the Margin configuration, it always occupies entire page.

Represents the segment at the very top of the page, just above the main content.

This container does not support paging capability. It's expected to be fully displayed on every page.

Represents the primary content, located in-between the header and footer.

This container does support paging capability and determines the final lenght of the document.

Represents the section at the very bottom of the page, just below the main content.

This container does not support paging capability. It's expected to be fully displayed on every page.

Creates a new page set with consistent attributes, such as margin, color, and watermark. The length of each set depends on its content.

By leveraging multiple page sets, you can produce documents containing pages of distinct sizes and characteristics. Delegate to define page content (layout and visual elements). Continuation of the Document API chain, permitting the definition of other page sets.

Rotates its content 90 degrees counterclockwise. Learn more

Note: Rotation can alter certain attributes; for example, 'width' might effectively become 'height'.

Rotates its content 90 degrees clockwise. Learn more

Note: Rotation can alter certain attributes; for example, 'width' might effectively become 'height'.

Rotates its content clockwise by a given angle. Learn more

Rotation angle in degrees. A value of 360 degrees represents a full rotation.

Adjusts horizontal spacing between items.

Adds a new item to the row element. This item occupies space proportionally to other relative items.

For a row element with a width of 100 points that has three items (a relative item of size 1, a relative item of size 5, and a constant item of size 10 points), the items will occupy sizes of 15 points, 75 points, and 10 points respectively. The container of the newly added item.

Adds a new item to the row element with a specified constant size.

The container of the newly created item.

Adds a new item to the row element. The size of this item adjusts based on its content.

The AutoItem requests as much horizontal space as its content requires. It doesn't adjust its size based on other items and may frequently result in a . It's recommended to use this API in conjunction with the MaxWidth element. The container of the newly created item.

Draws a collection of elements horizontally. Depending on the content direction mode, elements will be drawn from left to right, or from right to left.
Learn more

Supports paging. Depending on its content, the Row element may repeatedly draw certain items across multiple pages. Use the ShowOnce element to modify this behavior if it's not desired. The action to configure the row's content.

Scales its inner content proportionally. Learn more

Although this adjustment modifies the space available to its inner content, some elements might use their own strategies to fill that space. For example, an Image with the setting may retain its size, but its quality could vary based on the DPI setting. In contrast, text will not only appear smaller or bigger; but also a different number of words may fit each line. The scaling factor. Values greater than one enlarge the content, while values less than one reduce it.

Scales the available horizontal space (along the X axis), causing content to appear expanded or squished, rather than simply larger or smaller. Learn more

Scales the available vertical space (along the Y axis), causing content to appear expanded or squished, rather than simply larger or smaller. Learn more

Flips its content to create a mirror image along the Y axis, swapping elements from left to right. Learn more

Elements on the left will appear on the right.

Flips its content to create a mirror image along the X axis, moving elements from the top to the bottom. Learn more

Elements at the top will be positioned at the bottom.

Creates a mirror image of its content across both axes. Learn more

Elements originally in the top-left corner will be positioned in the bottom-right corner.

Excludes the container content from the semantic tree. Use for decorative elements, layout artifacts, or other non-structural content that shouldn't be part of the document's logical structure.

Marks a self-contained body of text that forms a single narrative or exposition, such as a blog post, news story, or forum post. As a best practice, articles should not be nested within each other.

Applies a 'Section' tag, grouping a set of related content. A section typically includes a heading (e.g., SemanticHeader2) and its corresponding content. Sections can be nested to create a hierarchical document structure.

Marks a generic block-level container for grouping elements. It's often used when a more specific semantic tag (like 'Article' or 'Section') doesn't apply, serving as a general-purpose 'div', similar to its HTML counterpart.

Designates a block of text that is a quotation, typically consisting of one or more paragraphs. This is for block-level quotes, as opposed to which is for inline text.

Identifies a brief portion of text that serves as a caption or description for a table, figure, or image. It should be placed near the element it describes.

Marks a section of the document as an index. This container typically holds a sequence of entries and references.

Applies a language attribute to a container, specifying the natural language (e.g., 'en-US', 'es-ES') of its content. This is crucial for accessibility, enabling screen readers to use the correct pronunciation.

The ISO 639 language code (e.g., 'en-US' or 'fr-FR') for the content.

Marks a container as a Table of Contents (TOC). A TOC should be composed of elements. TOCs can be nested to represent a hierarchical document structure. This tag can also be used for lists of figures, lists of tables, or bibliographies.

Marks an individual item within a . This typically represents a single entry in the list.

Marks the content as a level 1 heading (H1), the highest level in the document hierarchy. Headings are crucial for navigation and outlining the document's structure.

Marks the content as a level 2 heading (H2).

Marks the content as a level 3 heading (H3).

Marks the content as a level 4 heading (H4).

Marks the content as a level 5 heading (H5).

Marks the content as a level 6 heading (H6), the lowest level in the document hierarchy.

Marks a container as a paragraph. This is one of the most common block-level tags for organizing text content.

Marks a container as a list. Its direct children should be one or more elements. A can also be included as an optional first child.

Marks an individual item within a . Its children should typically be a (e.g., the bullet or number) and/or a (the content).

Marks the label of a list item. This container holds the bullet, number (e.g., '1.'), or term (in a definition list) that identifies the list item.

Marks the body or descriptive content of a . This contains the main text or content associated with the list item's label.

Marks a container as a table. The library automatically automatically tags headers, rows, cells, etc.

Marks a generic inline portion of text (Span). This is useful for grouping inline elements or applying styling, similar to an HTML <span>.

Optional alternative text, often used to provide an expansion for an abbreviation or other supplementary information.

Marks an inline portion of text as a quote. This differs from , which is intended for block-level content (one or more paragraphs).

Marks a fragment of text as computer code.

Marks the content as a hyperlink (Link).

Alternative text describing the link's purpose or destination. This is essential for screen readers.

Marks a container as a figure, which is an item of graphical content like a chart, diagram, or photograph.

A textual description of the figure, read by screen readers. This is essential for accessibility.

An alias for . Marks the content as an image.

A textual description of the image, read by screen readers. This is essential for accessibility.

Marks the content as a mathematical formula. From a structural and accessibility standpoint, it is treated similarly to a figure.

Renders its content in the most compact size achievable. Ideal for situations where the parent element provides more space than necessary.
Learn more

Minimizes content height to the minimum, optimizing vertical space. Ideal for situations where the parent element provides more space than necessary.
Learn more

Minimizes content width to the minimum, optimizing horizontal space. Ideal for situations where the parent element provides more space than necessary.
Learn more

Sets a uniform border around the container with the specified thickness and color.

Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Sets a solid background color behind its content. Learn more

Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Applies a linear gradient background to the container with the specified angle and colors.

The angle in degrees of the gradient direction. An array of representing the gradient colors.

Sets a uniform border (all edges) for its content. Learn more

Sets a vertical border (left and right) for its content. Learn more

Sets a horizontal border (top and bottom) for its content. Learn more

Sets a border on the left side of its content. Learn more

Sets a border on the right side of its content. Learn more

Sets a border on the top side of its content. Learn more

Sets a border on the bottom side of its content. Learn more

Applies a uniform corner radius to all corners of the container with the specified value and unit.

Applies a corner radius to the top-left corner of the container with the specified value and unit.

Applies a corner radius to the top-right corner of the container with the specified value and unit.

Applies a border radius to the bottom-left corner of the container with the specified value and unit.

Applies a corner radius to the bottom-right corner of the container with the specified value and unit.

Adjusts color of the border element. Learn more

Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Sets a linear gradient for the border with the specified angle and colors.

The angle of the gradient in degrees. An array of objects representing the gradient colors.

Aligns the container's border to the outer edge of the element.

Aligns the border in the middle of the specified container boundaries. This option is used by default when no alignment is specified.

Aligns the border to the inside of the container.

Applies a shadow to the container using the specified shadow style. Shadows can enhance the visual depth and separation of elements in a document.

Generates an SVG image based on the given resolution.

Desired resolution of the image in pixels. An SVG format compatible text.

Scales the image to fill the full width of its container. This is the default behavior.

The image stretches vertically to fit the full available height. Often used with height-constraining elements such as: Height, MaxHeight, etc.

An optimal and safe choice.

Draws the SVG image loaded from a text. Learn more

Multiple strategies exist for the Image element to determine its final size. By default, the image fills all the available width. This behavior can be customized using options within the descriptor class. Either a path to the SVG file or the SVG content itself. Descriptor allowing adjustments to the SVG image scaling behavior.

Draws the object. Allows to optimize the generation process. Learn more

Multiple strategies exist for the Image element to determine its final size. By default, the image fills all the available width. This behavior can be customized using options within the descriptor class. Descriptor allowing adjustments to the SVG image scaling behavior.

Renders an SVG image of dynamic size dictated by the document layout constraints.

Ideal for integrating with other libraries, e.g. SkiaSharp or ScottPlot. A delegate that requests an image of desired size.

Defines a column of constant size that occupies the specified horizontal space.

The container of the newly created column.

Defines a column with a relative size that adjusts its width in relation to other relative columns. Learn more

For a table 100 points wide with three columns: a relative size of 1, a relative size of 5, and a constant size of 10 points, they will span 15 points, 75 points, and 10 points respectively. The container for the newly defined column.

Inserts a new item into the table element.

The container for the newly inserted cell. Provides options to adjust the cell's position, size, and content.

Specifies the order and size of the table columns. Learn more

This configuration affects both the main content as well as the header and footer sections. Handler to define columns of the table.

Adjusts rendering algorithm to better handle complex table structures, especially those spanning multiple pages. This applies a unique rule to the final cells in each column, ensuring they stretch to fill the table's bottom edge. Such an approach can enhance your table's visual appeal.

Specifies a table header that appears on each page, positioned above the main content. The cell placement and dimensions in this header are distinct from those in the main content. Learn more

Handler for configuring the header cells.

Specifies a table footer that appears on each page, positioned below the main content. The placement and dimensions of cells within this footer are distinct from the main content. Learn more

Inserts a new item into the table element.

The container for the newly inserted cell, enabling customization of its position, size, and content.

Renders a set of items utilizing the table layout algorithm. Items may be auto-placed based on the order they're called or can have assigned specific column and row positions. Cells can also span multiple columns and/or rows.

Handler to define the table content.

Specifies the column position (horizontal axis) of the cell. Learn more

Columns are numbered starting with 1.

Defines the number of columns a cell spans in the horizontal axis. Learn more

Useful when creating complex layouts.

Specifies the row position (vertical axis) of the cell. Learn more

Rows are numbered starting with 1.

Defines the number of rows a cell spans in the vertical axis. Learn more

Useful when creating complex layouts.

Marks the specified table cell as a semantic horizontal header. This allows assistive technologies to recognize the cell as a header, improving accessibility and semantic structure.

Transforms a page number into a custom text format (e.g., roman numerals).

When is null, the delegate should return a default placeholder text of a typical length.

Provides the capability to render the page number in a custom text format (e.g., roman numerals). Lear more

The function designated to modify the number into text. When given a null input, a typical-sized placeholder text must be produced.

Aligns text horizontally to the left side.

Aligns text horizontally to the center, ensuring equal space on both left and right sides.

Aligns content horizontally to the right side.

Justifies the text within its container. This method sets the horizontal alignment of the text to be justified, meaning it aligns along both the left and right margins. This is achieved by adjusting the spacing between words and characters as necessary so that each line of text stretches from one end of the text column to the other. This creates a clean, block-like appearance for the text.

Aligns the text horizontally to the start of the container. This method sets the horizontal alignment of the text to the start (left for left-to-right languages, right for right-to-left languages).

Aligns the text horizontally to the end of the container. This method sets the horizontal alignment of the text to the end (right for left-to-right languages, left for right-to-left languages).

Limits the number of visible lines in a paragraph, truncating overflow text with an ellipsis or by hiding it to maintain layout consistency.

Adjusts the vertical gap between successive paragraphs (separated by line breaks), helping to visually separate blocks of text for improved readability.

Specifies the horizontal offset of the first line in a paragraph. Commonly used to visually separate paragraphs in a block of text.

Applies a consistent text style for the whole content within this Text element.

The TextStyle object to override the default inherited text style.

Applies a consistent text style for the whole content within this Text element.

Handler to modify the default inherited text style.

Aligns text horizontally to the left side.

Aligns text horizontally to the center, ensuring equal space on both left and right sides.

Aligns content horizontally to the right side.

Aligns the text horizontally to the start of the container. This method sets the horizontal alignment of the text to the start (left for left-to-right languages, right for right-to-left languages).

Aligns the text horizontally to the end of the container. This method sets the horizontal alignment of the text to the end (right for left-to-right languages, left for right-to-left languages).

Limits the number of visible lines in a paragraph, truncating overflow text with an ellipsis or by hiding it to maintain layout consistency.

Adjusts the vertical gap between successive paragraphs (separated by line breaks), helping to visually separate blocks of text for improved readability.

Specifies the horizontal offset of the first line in a paragraph. Commonly used to visually separate paragraphs in a block of text.

Appends the given text to the current paragraph.

Handler for adjusting the appearance of the text span, including attributes like color, size, and background.

Appends a line with the provided text followed by an environment-specific newline character.

Handler for adjusting the appearance of the text span, including attributes like color, size, and background.

Appends a blank line.

Handler for adjusting the appearance of the text span, including attributes like color, size, and background.

Appends text showing the current page number.

Handler for adjusting the appearance of the text span, including attributes like color, size, and background. Additionally, it provides formatting options, like displaying the page number in custom text format (e.g. Roman numerals).

Appends text showing the total number of pages in the document.

Appends text showing the number of the first page of the specified Section.

The text key corresponding to the value used when defining the Section element. Handler for adjusting the appearance of the text span, including attributes like color, size, and background. Additionally, it provides formatting options, like displaying the page number in custom text format (e.g. Roman numerals).

Appends text showing the number of the last page of the specified Section.

Appends text showing the page number relative to the beginning of the given Section.

For a section spanning pages 20 to 50, page 35 will show as 15. The text key corresponding to the value used when defining the Section element. Handler for adjusting the appearance of the text span, including attributes like color, size, and background. Additionally, it provides formatting options, like displaying the page number in custom text format (e.g. Roman numerals).

Appends text showing the total number of pages within the given Section.

For a section spanning pages 20 to 50, the total is 30 pages. The text key corresponding to the value used when defining the Section element. Handler for adjusting the appearance of the text span, including attributes like color, size, and background. Additionally, it provides formatting options, like displaying the page number in custom text format (e.g. Roman numerals).

Creates a clickable text that navigates the user to a specified Section.

The text key corresponding to the value used when defining the Section element. Handler for adjusting the appearance of the text span, including attributes like color, size, and background.

Creates a clickable text that redirects the user to a specific webpage.

The URL of the webpage to which the user will be redirected. Handler for adjusting the appearance of the text span, including attributes like color, size, and background.

Embeds custom content within the text.

The container must fit within one line and can not span multiple pages. Defines the position of the injected element in relation to text typography features (baseline, top/bottom edge). A container for the embedded content. Populate using the Fluent API.

Embeds custom content within the text.

The container must fit within one line and can not span multiple pages. Defines the position of the injected element in relation to text typography features (baseline, top/bottom edge). Delegate to populate the embedded container with custom content.

Draws rich formatted text.

Handler to define the content of the text elements (e.g.: paragraphs, spans, hyperlinks, page numbers).

Draws the provided text on the page

Handler for adjusting the appearance of the text span, including attributes like color, size, and background.

Sets a font style using the typography pattern. Learn more

This API reduces the garbage collector pressure and offers the best performance.

Sets the font color. The font color determines the color applied to text characters, affecting their visual appearance.

It also influences the default color of text decorations, such as underlines. Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Sets a solid background color for the text. This color fills the area behind the text or other elements, enhancing contrast and providing visual emphasis.

Color in a valid format (like #FF8800 for orange) or from the predefined set (like Colors.Red.Lighten1).

Sets the font family of the text. A font family is a collection of related fonts that share a consistent design style but may vary in weight, style, or width. Examples of font families include Arial, Times New Roman, and Calibri.

By default, the library searches all fonts available in the runtime environment. This may work well on the development environment but may fail in the cloud where fonts are usually not installed. It is safest deploy font files along with the application and then register them using the FontManager class. Actual font family (e.g. "Times New Roman", "Calibri", "Lato") or custom identifier used when invoking the FontManager method.

Sets font size for the text. Font size measures the height of text characters, determining how large or small the text appears.

It's worth noting that different fonts may render text with distinct visual sizes, even when assigned the same numerical font size.

Adjusts the vertical spacing between lines of text, affecting readability and overall text layout. The added space is proportional to the text size. A value of 1 retains the original spacing. Learn more

Sets the proportion of vertical spacing relative to the font size. A value greater than 1 increases the spacing, while a value less than 1 decreases it. The value must be greater than 0. A value of 1 sets the line height equal to the font size. This setting may result in insufficient vertical spacing around the text. A value of default indicates that the font metrics should be used to calculate the line spacing, which is the default behavior.

Adjusts the horizontal spacing between characters in the text, affecting readability and overall visual style. The adjustment is proportional to the text size. Learn more

Sets the proportion by which the horizontal space between characters is changed. A value of 0 maintains the original spacing. When the value is positive, the text is more spread out. When it is negative, the text is more condensed.

Adjusts the horizontal spacing between words in the text, affecting readability and overall visual style. The adjustment is proportional to the text size.

Sets the proportion by which the horizontal space between words is changed. A value of 0 maintains the original spacing. When the value is positive, the text is more spread out. When it is negative, the text is more condensed.

Renders text with an italic effect, where letters are slightly slanted to the right. Commonly used for emphasis or to distinguish specific words.

Allows text to wrap at any character, not just spaces.

Draws a line through the middle of the text.

You can control the decoration visuals by setting color and style (solid, double, wavy, dotted, dashed) of the line.

Draws a line under the text.

You can control the decoration visuals by setting color and style (solid, double, wavy, dotted, dashed) of the line.

Draws a line above the text.

You can control the decoration visuals by setting color and style (solid, double, wavy, dotted, dashed) of the line.

Sets the color of the text decoration.

Applies for the following text decorations: striketrough, underline, overline.

Changess thickness of decoration line proportionally to the provided argument. Value equal to 1 is the default thickness.

Applies for the following text decorations: striketrough, underline, overline.

Sets the decoration line to a solid straight line.

Applies for the following text decorations: striketrough, underline, overline.

Sets the decoration line to a solid double line.

Applies for the following text decorations: striketrough, underline, overline.

Sets the decoration line to wave.

Applies for the following text decorations: striketrough, underline, overline.

Sets the decoration line to dots.

Applies for the following text decorations: striketrough, underline, overline.

Sets the decoration line to dashes.

Applies for the following text decorations: striketrough, underline, overline.

Sets the font weight to "thin" (equivalent to CSS 100). Learn more

Determines the thickness of the text characters, ranging from light to bold, to create visual hierarchy or emphasis. Not all fonts support every weight. If the specified weight isn't available, the library selects the closest available option.

Sets the font weight to "extra light" (equivalent to CSS 200). Learn more

Sets the font weight to "light" (equivalent to CSS 300). Learn more

Sets the font weight to "normal" or "regular (equivalent to CSS 400). Learn more

Sets the font weight to "medium" (equivalent to CSS 500). Learn more

Sets the font weight to "semi bold" (equivalent to CSS 600). Learn more

Sets the font weight to "bold" (equivalent to CSS 700). Learn more

Sets the font weight to "extra bold" (equivalent to CSS 800). Learn more

Sets the font weight to "black" (equivalent to CSS 900). Learn more

Sets the font weight to "extra black" (equivalent to CSS 1000). Learn more

Resets the text position and size to default, utilizing the full available line height. Learn more

Sets the text style to subscript, making it smaller and positioning it below the baseline, e.g.: H₂0. Learn more

Sets the text style to subscript, making it smaller and positioning it above the baseline, e.g.: y² + x² = 1. Learn more

Resets the text direction, enabling content to follow the automatically detected direction.

Enforces a left-to-right text direction.

Enforces a right-to-left text direction.

Enables or disables font features defined by the OpenType standard, e.g. kernig, ligatures. Font features are always encoded as 4-character long strings. For example, the ligatures feature is encode as liga, while the kernig feature as kern. For a list of available features, refer to the FontFeatures class.

To better understand what font features are, please consider example definitions. Please note that there are many more various font features. Most fonts support only a handful of them, having some of them enabled by default: Ligatures in typography are specific character combinations that are designed to improve the aesthetics and readability of certain letter pairs. For example, in some fonts, when you type certain combinations of letters like 'fi' or 'fl', they will be replaced with a single, joined glyph. Kerning in typography refers to the adjustment of space between characters in a proportional font. It's used to achieve a visually pleasing result by adjusting the spacing of specific character pairs. For example, in many fonts, the pair 'AV' is kerned so that the 'A' and 'V' are closer together than they would be by default. TextStyle.Default.EnableFontFeature(FontFeatures.StandardLigatures); TextStyle.Default.DisableFontFeature(FontFeatures.Kerning); Provide font feature name or use the FontFeatures class.