Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

HtmlToPdfOptions

Edit on GitHub
Namespace OfficeIMO.Html.Pdf
Assembly OfficeIMO.Html.Pdf
Source ../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:21
Base HtmlRenderOptions
Modifiers sealed

Controls direct HTML layout and PDF generation. Layout, resource, page, and safety settings are inherited from HtmlRenderOptions.

Inheritance

  • HtmlRenderOptions
  • HtmlToPdfOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Examples


var options = new HtmlToPdfOptions {
    PageSize = OfficePageSizes.A4,
    Margins = HtmlRenderMargins.All(32),
    DefaultFontFamily = "Arial"
};
byte[] pdf = HtmlConversionDocument.Parse(html).ToPdfBytes(options);

Constructors

HtmlToPdfOptions 2 overloads
public HtmlToPdfOptions() #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:21

Creates direct paged HTML-to-PDF options using the standard defaults.

public HtmlToPdfOptions(HtmlRenderOptions renderOptions) #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:21

Creates PDF-capable options from shared HTML rendering settings without changing their layout mode. PDF conversion enforces paged layout on its own conversion snapshot.

Parameters

renderOptions OfficeIMO.Html.HtmlRenderOptions requiredposition: 0
Shared settings used by PNG, SVG, and PDF rendering.

Methods

public override HtmlRenderOptions Clone() #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:121
Returns: HtmlRenderOptions

Creates an independent options snapshot.

public HtmlToPdfOptions ClonePdf() #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:117
Returns: HtmlToPdfOptions

Creates an independent options snapshot for one PDF conversion.

public HtmlPdfResourcePolicySummary GetResourcePolicySummary() #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:124
Returns: HtmlPdfResourcePolicySummary

Returns a snapshot of the active HTML resource policy.

Properties

public PdfTextFallbackFeatures TextFallbacks { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:51

OfficeIMO-managed font fallback groups used by generated PDF text.

public PdfTextShapingMode TextShapingMode { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:56

Dependency-free shaping mode used by generated PDF text.

public PdfEmbeddedFontFamily FontFamily { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:59

Optional caller-supplied embedded font family used by generated PDF text.

public Boolean InteractiveFormControls { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:65

Converts supported standard HTML inputs, text areas, and selects into interactive AcroForm fields. Disable this to retain the shared renderer's static control paint in the PDF.

public Int32 MaxOutlinedTextCharactersPerRun { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:72

Maximum UTF-16 characters expanded into vector font outlines for one rendered text run. Raise this only for trusted documents with unusually long unbroken text.

public Int32 MaxOutlinedTextPathCommands { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:83

Maximum path commands generated by text outlines across one PDF conversion.

public PdfOptions PdfOptions { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:99

PDF writer settings used for the generated document, including file version, forward-only serialization, tagging, compliance groundwork, and output intents.

public IOfficeTextShapingProvider TextShapingProvider { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:105

Optional host-provided shaping seam used with caller-supplied or resolved embedded fonts.

public PdfResourcePolicy ResourcePolicy { get; set; } #
../../../../_/OfficeIMO.Html.Pdf/HtmlToPdfOptions.cs:111

Host-resource policy. Defaults to balanced conversion: system fonts and bounded in-source resources are allowed, while local and remote reads are denied.