API Reference
MarkdownToPdfOptions
Options for converting OfficeIMO.Markdown documents to first-party PDF documents.
Inheritance
- Object
- MarkdownToPdfOptions
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
- Method MarkdownPdfConverterExtensions.SaveAsPdf
- Method MarkdownPdfConverterExtensions.SaveAsPdf
- Method MarkdownPdfConverterExtensions.SaveAsPdfAsync
- Method MarkdownPdfConverterExtensions.SaveAsPdfAsync
- Method MarkdownPdfConverterExtensions.SaveAsPdfResult
- Method MarkdownPdfConverterExtensions.SaveAsPdfResult
- Method MarkdownPdfConverterExtensions.SaveAsPdfResultAsync
- Method MarkdownPdfConverterExtensions.SaveAsPdfResultAsync
- Method MarkdownPdfConverterExtensions.ToPdfBytes
- Method MarkdownPdfConverterExtensions.ToPdfDocument
- Method MarkdownPdfConverterExtensions.ToPdfDocumentResult
Constructors
public MarkdownToPdfOptions() #Methods
public MarkdownToPdfOptions Clone() #MarkdownToPdfOptionsCreates an independent copy of these conversion options.
public MarkdownToPdfOptions UseProfile(PdfExportProfile profile) #MarkdownToPdfOptionsApplies a high-level export profile by setting the Markdown PDF options that correspond to that profile.
Parameters
- profile OfficeIMO.Pdf.PdfExportProfile
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public PdfOptions PdfOptions { get; set; } #PDF creation options passed to the first-party PDF engine.
public String FontFamily { get; set; } #Optional Markdown default font family used by the first-party PDF engine.
public PdfTextFallbackFeatures TextFallbacks { get; set; } #Built-in generated-text fallback groups applied by the Markdown PDF converter. Set to None for exact standard-font output.
public PdfResourcePolicy ResourcePolicy { get; set; } #Host-resource policy. Defaults to balanced conversion: system fonts and bounded in-source resources are allowed, while local and remote reads are denied.
public Boolean IncludeImages { get; set; } #When true, supported image references are rendered. Resource access is still governed by ResourcePolicy.
public Boolean ApplyDefaultTheme { get; set; } #Applies the built-in Word-like PDF theme before rendering Markdown blocks.
public MarkdownVisualTheme Theme { get; set; } #Shared Markdown visual theme used to align PDF output with HTML and Word exporters. When set, this is translated into PDF-specific styling unless Style is also set.
public MarkdownPdfStyle Style { get; set; } #PDF-specific layout and rendering style overrides. Preset selection belongs to Theme so HTML, PDF, and Word share one visual-theme catalog.
public Boolean UseFrontMatterTheme { get; set; } #Use theme, visualTheme, pdfTheme, or equivalent front matter values as the visual profile when no explicit theme is set.
public Boolean CreateOutlineFromHeadings { get; set; } #Create PDF outlines from supported Markdown headings.
public Boolean UseFrontMatterMetadata { get; set; } #Use common front matter keys such as title, author, subject, description, keywords, and tags as PDF metadata.
public MarkdownPdfFrontMatterRenderMode FrontMatterRenderMode { get; set; } #Controls whether front matter is rendered as a document heading, a metadata table, or hidden from the PDF body.
public Boolean UseFirstHeadingAsTitle { get; set; } #Use the first Markdown heading as PDF title metadata when no explicit or front matter title is available.
public String Title { get; set; } #Explicit PDF title metadata. When null, front matter or the first heading can be used.
public String Author { get; set; } #Explicit PDF author metadata. When null, front matter author can be used.
public String Subject { get; set; } #Explicit PDF subject metadata. When null, front matter subject, description, or summary can be used.
public String Keywords { get; set; } #Explicit PDF keywords metadata. When null, front matter keywords or tags can be used.
public String BaseDirectory { get; set; } #Base directory used to resolve relative local image paths.
public Boolean RestrictLocalImagesToBaseDirectory { get; set; } #When true and BaseDirectory is set, local image paths must resolve inside that directory.
public Int32 MaximumDataUriImageBytes { get; set; } #Maximum decoded byte length for a single data URI image.
public Func<Uri, Byte[]> RemoteImageResolver { get; set; } #Optional resolver for HTTPS/HTTP Markdown images. When null, remote images are rendered as placeholders and recorded as warnings.
public Int32 MaximumRemoteImageBytes { get; set; } #Maximum byte length accepted from RemoteImageResolver for a single remote image.
public Double DefaultImageWidth { get; set; } #Fallback image width in points when Markdown did not provide a width hint.
public Double DefaultImageHeight { get; set; } #Fallback image height in points when Markdown did not provide a height hint.