MarkdownSaveOptions Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Represents options for saving to Markdown (MD) format.

• C#
• VB.NET

public sealed class MarkdownSaveOptions : SaveOptions

Public NotInheritable Class MarkdownSaveOptions
    Inherits SaveOptions

Inheritance:

System.Object

SaveOptions

MarkdownSaveOptions

Remarks

Pictures are exported only if one of the following is true:

• Save(String) or Save(String, SaveOptions) overload is used
• FilesDirectoryPath or EmbedImages is specified

Constructors

MarkdownSaveOptions()

Initializes a new instance of the MarkdownSaveOptions class.

• C#
• VB.NET

public MarkdownSaveOptions()

Public Sub New

Properties

ContentType

Gets the content-type for Markdown file format: "text/markdown; charset=" + Encoding.System.Text.Encoding.WebName.

• C#
• VB.NET

public override string ContentType { get; }

Public Overrides ReadOnly Property ContentType As String

Property Value

System.String

The content-type for Markdown file format.

Overrides

SaveOptions.ContentType

EmbedImages

Gets or sets a value indicating whether images are embedded directly within the Markdown file as Base64-encoded data URIs.

• C#
• VB.NET

public bool EmbedImages { get; set; }

Public Property EmbedImages As Boolean

Property Value

System.Boolean

true if images are embedded directly within the Markdown file as Base64-encoded data URIs; otherwise, false.

Encoding

Gets or sets the encoding for the Markdown file.

• C#
• VB.NET

public Encoding Encoding { get; set; }

Public Property Encoding As Encoding

Property Value

System.Text.Encoding

The encoding for the Markdown file.

Exceptions

System.ArgumentNullException

Value is set to null.

FilesDirectoryPath

Gets or sets the physical directory where Pictures will be saved.

• C#
• VB.NET

public string FilesDirectoryPath { get; set; }

Public Property FilesDirectoryPath As String

Property Value

System.String

The physical directory where Pictures will be saved.

Remarks

If value is null or System.String.Empty and Markdown export is called with Save(String) or Save(String, SaveOptions) overload, value will be automatically set to markdownFileNameWithoutExtension + "_files". This directory will be created in the same location as the Markdown file.

FilesDirectorySrcPath

Gets or sets the relative directory that will be used when referencing Pictures in the Markdown.

• C#
• VB.NET

public string FilesDirectorySrcPath { get; set; }

Public Property FilesDirectorySrcPath As String

Property Value

System.String

The relative directory that will be used when referencing Pictures in the Markdown.

Remarks

If value is null or System.String.Empty and Markdown export is called with Save(String) or Save(String, SaveOptions) overload, value will be automatically set to markdownFileNameWithoutExtension + "_files".

Inherited Properties

DocxDefault	Gets the default saving options for Microsoft Word file format. Word file will be saved in Docx format. (Inherited from SaveOptions)
HtmlDefault	Gets the default saving options for HyperText Markup Language (HTML) format. (Inherited from SaveOptions)
ImageDefault	Gets the default saving options for image file format. Image will be saved in Bmp format. (Inherited from SaveOptions)
MarkdownDefault	Gets the default saving options for Markdown file format. (Inherited from SaveOptions)
OdtDefault	Gets the default saving options for Open Document file format. (Inherited from SaveOptions)
PageCount	Gets or sets the number of pages which should be saved. (Inherited from SaveOptions)
PageNumber	Gets or sets the zero-based page number of the document's first page which should be saved. (Inherited from SaveOptions)
PdfDefault	Gets the default saving options for Portable Document Format (PDF). (Inherited from SaveOptions)
RtfDefault	Gets the default saving options for Rich Text (RTF) format. (Inherited from SaveOptions)
TxtDefault	Gets the default saving options for Plain Text (TXT) format. (Inherited from SaveOptions)
XmlDefault	Gets the default saving options for XML file format. (Inherited from SaveOptions)
XpsDefault	Gets the default saving options for XML Paper Specification (XPS) format. (Inherited from SaveOptions)