Groupdocs API References – ConvertOptions class

Python-Net: init constructor

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

init

Initializes a new instance of the ConvertOptions class.

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

def __init__(self):
    ...

Python-Net: flavor property

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

flavor property

The target Markdown dialect. Default is MarkdownFlavor.git_hub.

Definition:

@property
def flavor(self):
    ...
@flavor.setter
def flavor(self, value):
    ...

Python-Net: heading_level_offset property

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

heading_level_offset property

The offset to apply to all heading levels in the Markdown output. Default is 0 (no change).

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 #.

Definition:

@property
def heading_level_offset(self):
    ...
@heading_level_offset.setter
def heading_level_offset(self, value):
    ...

Python-Net: image_export_strategy property

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

image_export_strategy property

The strategy for handling images during conversion. Default is ExportImagesAsBase64Strategy.

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.

Definition:

@property
def image_export_strategy(self):
    ...
@image_export_strategy.setter
def image_export_strategy(self, value):
    ...

Python-Net: include_front_matter property

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

include_front_matter property

The option indicating whether to prepend YAML front matter to the Markdown output. Default is False.

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

Definition:

@property
def include_front_matter(self):
    ...
@include_front_matter.setter
def include_front_matter(self, value):
    ...

Python-Net: include_hidden_sheets property

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

include_hidden_sheets property

The property indicates whether hidden worksheets are included in spreadsheet conversions.

Default is False.

Definition:

@property
def include_hidden_sheets(self):
    ...
@include_hidden_sheets.setter
def include_hidden_sheets(self, value):
    ...

Python-Net: max_columns property

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

max_columns property

The maximum number of columns to include per table when converting spreadsheets; columns beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default).

Definition:

@property
def max_columns(self):
    ...
@max_columns.setter
def max_columns(self, value):
    ...

Python-Net: max_rows property

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

max_rows property

The maximum number of data rows to include per worksheet when converting spreadsheets; rows beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default).

Definition:

@property
def max_rows(self):
    ...
@max_rows.setter
def max_rows(self, value):
    ...

Python-Net: page_numbers property

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

page_numbers property

The page numbers to convert, as a list of 1‑based page or worksheet numbers.

If set to None, all pages are converted. The default is None.

Definition:

@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...

Python-Net: sheet_separator property

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

sheet_separator property

The separator inserted between worksheets in spreadsheet conversions.

Default is a horizontal rule (`

`).

Definition:

@property
def sheet_separator(self):
    ...
@sheet_separator.setter
def sheet_separator(self, value):
    ...

Python-Net: uri_export_strategy property

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

uri_export_strategy property

The strategy for customizing resource URIs written to Markdown output.

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

Definition:

@property
def uri_export_strategy(self):
    ...
@uri_export_strategy.setter
def uri_export_strategy(self, value):
    ...

Groupdocs API References – ConvertOptions class

Python-Net: __init__ constructor

init

See Also

Python-Net: flavor property

flavor property

Definition:

See Also

Python-Net: heading_level_offset property

heading_level_offset property

Definition:

See Also

Python-Net: image_export_strategy property

image_export_strategy property

Definition:

See Also

Python-Net: include_front_matter property

include_front_matter property

Definition:

See Also

Python-Net: include_hidden_sheets property

include_hidden_sheets property

Definition:

See Also

Python-Net: max_columns property

max_columns property

Definition:

See Also

Python-Net: max_rows property

max_rows property

Definition:

See Also

Python-Net: page_numbers property

page_numbers property

Definition:

See Also

Python-Net: sheet_separator property

sheet_separator property

Default is a horizontal rule (`

Definition:

See Also

Python-Net: uri_export_strategy property

uri_export_strategy property

Definition:

See Also

Python-Net: init constructor