Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordPdfExportOptions

OfficeIMO.Word.Pdf

Namespace
OfficeIMO.Word.Pdf
Assembly
OfficeIMO.Word.Pdf
Source revision
e163ccb36643 with working tree changes

Options controlling first-party OfficeIMO PDF export.

Inheritance

  • object
  • WordPdfExportOptions

Usage

Explore 8 API references to this type

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

Accepted by parameters 4

Constructors

public WordPdfExportOptions() #

Methods

public WordPdfExportOptions Clone() #

Creates an independent copy of renderer settings, including PDF options.

public WordPdfExportOptions UseProfile(PdfExportProfile profile) #

Applies a high-level export profile by setting the Word PDF options that correspond to that profile.

Parameters

profile OfficeIMO.Pdf.PdfExportProfile required
public WordPdfExportOptions UseRenderingProfile(OfficeRenderingProfile profile, OfficeRenderingProfileApplyMode mode = Replace) #

Applies shared deterministic typography resources to the first-party PDF engine. Word pagination and layout settings remain owned by this converter.

Parameters

profile OfficeIMO.Drawing.OfficeRenderingProfile required
mode OfficeIMO.Drawing.OfficeRenderingProfileApplyMode = Replace optional

Properties

public bool FailOnLoss { get; set; } #

Blocks output when conversion reports fidelity loss.

public int MaxImagesPerParagraph { get; set; } #

Maximum images collected from one Word paragraph during PDF export.

public PdfCreateOptions? PdfOptions { get; set; } #

PDF creation options passed to the first-party PDF engine. The options are cloned before export.

public string? FontFamily { get; set; } #

Optional Word-style font family used as the first-party PDF default font. When the resource policy allows system fonts, an installed family is embedded; otherwise it maps to the nearest PDF standard font.

public PdfResourcePolicy ResourcePolicy { get; set; } #

Host-resource policy. Balanced conversion embeds installed document fonts and uses installed substitutes for missing Office families. Local files and remote resources are disabled. Use PdfResourcePolicy.CreatePortableDeterministic for host-independent conversion.

public PdfTextFallbackFeatures TextFallbacks { get; set; } #

Built-in generated-text fallback groups applied by the Word PDF converter when system font embedding is allowed. Defaults to the recommended preset, but no host font files are embedded unless WordPdfExportOptions.ResourcePolicy allows them.

public WordFieldUpdateOptions? DateTimeFieldUpdateOptions { get; set; } #

Optional DATE and TIME field refresh before PDF conversion. When null, cached Word field results are used. Other field results remain unchanged. The refresh updates the source WordDocument in memory without saving the Word file. Set WordFieldUpdateOptions.CurrentDateTime for a fixed value.

public PdfPageSize? PageSize { get; set; } #

Optional page size in PDF points. The supplied geometry is preserved unless WordPdfExportOptions.Orientation is also set.

public PdfPageMargins? Margins { get; set; } #

Optional page margins in PDF points.

public OfficePageOrientation? Orientation { get; set; } #

Optional page orientation for the generated PDF.

public WordPageSize? DefaultPageSize { get; set; } #

Optional default page size applied when creating new documents.

public OfficePageOrientation? DefaultOrientation { get; set; } #

Optional default page orientation applied when creating new documents.

public string? Title { get; set; } #

Optional PDF title that overrides the Word document title.

public string? Author { get; set; } #

Optional PDF author that overrides the Word document author.

public string? Subject { get; set; } #

Optional PDF subject that overrides the Word document subject.

public string? Keywords { get; set; } #

Optional PDF keywords that override the Word document keywords.

public bool IncludePageNumbers { get; set; } #

Determines whether generated page numbers are rendered when the Word source has no page-number field. Defaults to false.

public string? PageNumberFormat { get; set; } #

Optional format for page numbers. Use "{current}" for the current page and "{total}" for total pages.

public bool DefaultTableBorders { get; set; } #

When true, draws subtle borders for table cells that do not define borders in the Word document. Defaults to false to preserve strict fidelity.

public WordPdfTrackedChangeView TrackedChanges { get; set; } #

Selects how tracked insertions and deletions are shown. Defaults to WordPdfTrackedChangeView.Markup, which underlines insertions and strikes through deletions in a revision colour. The final view reports when tracked revisions are projected into accepted text.