Groupdocs API References – ConvertOptions

Net: ConvertOptions

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions constructor

Initializes a new instance of the ConvertOptions class.

public ConvertOptions()

Remarks

By default, ImageExportStrategy is set to ExportImagesAsBase64Strategy, which embeds images as Base64 strings directly in the Markdown output.

Net: Flavor

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.Flavor property

Gets or sets the target Markdown dialect.

public MarkdownFlavor Flavor { get; set; }

Property Value

Default is GitHub.

Net: HeadingLevelOffset

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.HeadingLevelOffset property

Gets or sets the offset to apply to all heading levels in the Markdown output. A value of 2 turns # into ###, ## into ####, etc. Heading levels are clamped to the range 1-6.

public int HeadingLevelOffset { get; set; }

Property Value

Default is 0 (no change).

Remarks

This is useful when you are embedding the converted Markdown inside a larger document where top-level headings are already in use. For example, setting this to 1 ensures the converted content starts at ## instead of #.

Examples

Shift all headings down by one level so that source H1 becomes Markdown ##:

var options = new ConvertOptions { HeadingLevelOffset = 1 };
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);

Net: ImageExportStrategy

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.ImageExportStrategy property

Gets or sets the strategy for handling images during conversion.

public IImageExportStrategy ImageExportStrategy { get; set; }

Property Value

The image export strategy. Default is ExportImagesAsBase64Strategy.

Remarks

Built-in strategies:

ExportImagesAsBase64Strategy - Embeds images as Base64 strings (default)
ExportImagesToFileSystemStrategy - Saves images to a specified folder
SkipImagesStrategy - Skips image saving
CustomImagesStrategy - Custom image saving handler

Or implement IImageExportStrategy for a fully custom strategy.

Net: IncludeFrontMatter

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.IncludeFrontMatter property

Gets or sets a value indicating whether to prepend YAML front matter to the Markdown output. When enabled, document metadata (title, author, format, page count) is extracted and written as a YAML block at the beginning of the output.

public bool IncludeFrontMatter { get; set; }

Property Value

Default is false.

Remarks

Front matter is commonly used by static site generators such as Jekyll, Hugo, and Docusaurus. Only non-empty metadata fields are included.

Examples

var options = new ConvertOptions { IncludeFrontMatter = true };
string markdown = MarkdownConverter.ToMarkdown("report.docx", options);
// Output starts with:
// ---
// title: "Q3 Report"
// author: "Jane Doe"
// format: Docx
// pages: 12
// ---

Net: IncludeHiddenSheets

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.IncludeHiddenSheets property

Gets or sets whether hidden worksheets are included in spreadsheet conversions.

public bool IncludeHiddenSheets { get; set; }

Property Value

Default is false.

Net: MaxColumns

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.MaxColumns property

Gets or sets the maximum number of columns to include per table when converting spreadsheets. Columns beyond this limit are truncated with an ellipsis indicator.

public int MaxColumns { get; set; }

Property Value

0 means unlimited (default).

Net: MaxRows

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.MaxRows property

Gets or sets the maximum number of data rows to include per worksheet when converting spreadsheets. Rows beyond this limit are truncated with an ellipsis indicator.

public int MaxRows { get; set; }

Property Value

0 means unlimited (default).

Net: PageNumbers

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.PageNumbers property

Gets or sets an array of page or worksheet numbers to convert. Numbering starts from 1.

public int[] PageNumbers { get; set; }

Property Value

An array of 1-based page numbers to convert, or null to convert all pages. Default is null.

Net: SheetSeparator

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.SheetSeparator property

Gets or sets the separator inserted between worksheets in spreadsheet conversions.

public string SheetSeparator { get; set; }

Property Value

Default is a horizontal rule (\n---\n).

Net: UriExportStrategy

Mon, 01 Jan 0001 00:00:00 +0000

ConvertOptions.UriExportStrategy property

Gets or sets the strategy for customizing resource URIs written to Markdown output.

public IUriExportStrategy UriExportStrategy { get; set; }

Property Value

The URI export strategy, or null to keep the default URIs. Default is null.

Groupdocs API References – ConvertOptions

Net: ConvertOptions

ConvertOptions constructor

Remarks

See Also

Net: Flavor

ConvertOptions.Flavor property

Property Value

See Also

Net: HeadingLevelOffset

ConvertOptions.HeadingLevelOffset property

Property Value

Remarks

Examples

See Also

Net: ImageExportStrategy

ConvertOptions.ImageExportStrategy property

Property Value

Remarks

See Also

Net: IncludeFrontMatter

ConvertOptions.IncludeFrontMatter property

Property Value

Remarks

Examples

See Also

Net: IncludeHiddenSheets

ConvertOptions.IncludeHiddenSheets property

Property Value

See Also

Net: MaxColumns

ConvertOptions.MaxColumns property

Property Value

See Also

Net: MaxRows

ConvertOptions.MaxRows property

Property Value

See Also

Net: PageNumbers

ConvertOptions.PageNumbers property

Property Value

See Also

Net: SheetSeparator

ConvertOptions.SheetSeparator property

Property Value

See Also

Net: UriExportStrategy

ConvertOptions.UriExportStrategy property

Property Value

See Also