Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

WordToPdfOptions

Namespace OfficeIMO.Word.Pdf
Assembly OfficeIMO.Word.Pdf

Options controlling first-party OfficeIMO PDF export.

Inheritance

  • Object
  • WordToPdfOptions

Usage

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

Constructors

Methods

public WordToPdfOptions UseProfile(PdfExportProfile profile) #
Returns: WordToPdfOptions

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

Parameters

profile OfficeIMO.Pdf.PdfExportProfile requiredposition: 0
public WordToPdfOptions UseRenderingProfile(OfficeRenderingProfile profile, OfficeRenderingProfileApplyMode mode = Replace) #
Returns: WordToPdfOptions

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 requiredposition: 0
mode OfficeIMO.Drawing.OfficeRenderingProfileApplyMode = Replace optionalposition: 1

Properties

public Int32 MaxImagesPerParagraph { get; set; } #

Maximum images collected from one Word paragraph during PDF export.

public PdfOptions 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 allows explicitly selected system fonts, but disables document-selected font embedding, local files, and remote resources. Enable AllowDocumentFontEmbedding for trusted documents when preserving their installed fonts is required.

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 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 CurrentDateTime for a fixed value.

public Nullable<PageSize> PageSize { get; set; } #

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

public Nullable<PageMargins> Margins { get; set; } #

Optional page margins in PDF points.

public Nullable<OfficePageOrientation> Orientation { get; set; } #

Optional page orientation for the generated PDF.

public Nullable<WordPageSize> DefaultPageSize { get; set; } #

Optional default page size applied when creating new documents.

public Nullable<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 Boolean 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 Boolean 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.