Aspose::Words::Saving::MarkdownSaveOptions class

MarkdownSaveOptions class

Class to specify additional options when saving a document into the Markdown format. To learn more, visit the Specify Save Options documentation article.

class MarkdownSaveOptions : public TxtSaveOptionsBase

Methods

MethodDescription
MarkdownSaveOptions()Initializes a new instance of this class that can be used to save a document in the Markdown format.
get_EmptyParagraphExportMode() constSpecifies how to export empty paragraphs to Markdown. Default value is EmptyLine.
get_ExportAsHtml() constAllows to specify the elements to be exported to Markdown as raw HTML. Default value is None.
get_ExportImagesAsBase64()Specifies whether images are saved in Base64 format to the output file. Default value is false.
get_ExportUnderlineFormatting() constGets or sets a boolean value indicating either to export underline text formatting as sequence of two plus characters “++”. The default value is false.
get_ImageResolution()Specifies the output resolution for images when exporting to Markdown. Default is 96 dpi.
get_ImageSavingCallback()Allows to control how images are saved when a document is saved to Markdown format.
get_ImagesFolder() constSpecifies the physical folder where images are saved when exporting a document to the Markdown format. Default is an empty string.
get_ImagesFolderAlias() constSpecifies the name of the folder used to construct image URIs written into a document. Default is an empty string.
get_LinkExportMode() constSpecifies how links will be written to the output file. Default value is Auto.
get_ListExportMode() constSpecifies how list items will be written to the output file. Default value is MarkdownSyntax.
get_OfficeMathExportMode() constSpecifies how OfficeMath will be written to the output file. Default value is Text.
get_ResourceSavingCallback() constAllows to control how resources are saved when a document is exported to Markdown format.
get_SaveFormat() overrideSpecifies the format in which the document will be saved if this save options object is used. Can only be Markdown.
get_TableContentAlignment() constGets or sets a value that specifies how to align contents in tables when exporting into the Markdown format. The default value is Auto.
set_EmptyParagraphExportMode(Aspose::Words::Saving::MarkdownEmptyParagraphExportMode)Specifies how to export empty paragraphs to Markdown. Default value is EmptyLine.
set_ExportAsHtml(Aspose::Words::Saving::MarkdownExportAsHtml)Allows to specify the elements to be exported to Markdown as raw HTML. Default value is None.
set_ExportImagesAsBase64(bool)Specifies whether images are saved in Base64 format to the output file. Default value is false.
set_ExportUnderlineFormatting(bool)Sets a boolean value indicating either to export underline text formatting as sequence of two plus characters “++”. The default value is false.
set_ImageResolution(int32_t)Specifies the output resolution for images when exporting to Markdown. Default is 96 dpi.
set_ImageSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IImageSavingCallback> &)Allows to control how images are saved when a document is saved to Markdown format.
set_ImagesFolder(const System::String &)Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is an empty string.
set_ImagesFolderAlias(const System::String &)Specifies the name of the folder used to construct image URIs written into a document. Default is an empty string.
set_LinkExportMode(Aspose::Words::Saving::MarkdownLinkExportMode)Specifies how links will be written to the output file. Default value is Auto.
set_ListExportMode(Aspose::Words::Saving::MarkdownListExportMode)Specifies how list items will be written to the output file. Default value is MarkdownSyntax.
set_OfficeMathExportMode(Aspose::Words::Saving::MarkdownOfficeMathExportMode)Specifies how OfficeMath will be written to the output file. Default value is Text.
set_ResourceSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IResourceSavingCallback> &)Allows to control how resources are saved when a document is exported to Markdown format.
set_SaveFormat(Aspose::Words::SaveFormat) overrideSpecifies the format in which the document will be saved if this save options object is used. Can only be Markdown.
set_TableContentAlignment(Aspose::Words::Saving::TableContentAlignment)Sets a value that specifies how to align contents in tables when exporting into the Markdown format. The default value is Auto.
get_Encoding() constSpecifies the encoding to use when exporting in text formats. Default value is Encoding.UTF8.
get_ExportHeadersFootersMode() constSpecifies the way headers and footers are exported to the text formats. Default value is PrimaryOnly.
get_ForcePageBreaks() constAllows to specify whether the page breaks should be preserved during export.

The default value is false. | | get_ParagraphBreak() const | Specifies the string to use as a paragraph break when exporting in text formats. | | set_Encoding(const System::SharedPtr<System::Text::Encoding> &) | Specifies the encoding to use when exporting in text formats. Default value is Encoding.UTF8. | | set_ExportHeadersFootersMode(Aspose::Words::Saving::TxtExportHeadersFootersMode) | Specifies the way headers and footers are exported to the text formats. Default value is PrimaryOnly. | | set_ForcePageBreaks(bool) | Allows to specify whether the page breaks should be preserved during export.

The default value is false. | | set_ParagraphBreak(const System::String &) | Specifies the string to use as a paragraph break when exporting in text formats. | | static CreateSaveOptions(Aspose::Words::SaveFormat) | Creates a save options object of a class suitable for the specified save format. | | static CreateSaveOptions(const System::String &) | Creates a save options object of a class suitable for the file extension specified in the given file name. | | get_AllowEmbeddingPostScriptFonts() const | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false. | | get_CustomTimeZoneInfo() const | Gets or sets custom local time zone used for date/time fields. | | get_DefaultTemplate() const | Gets or sets path to default template (including filename). Default value for this property is empty string. | | get_Dml3DEffectsRenderingMode() const | Gets or sets a value determining how 3D effects are rendered. | | virtual get_DmlEffectsRenderingMode() | Gets or sets a value determining how DrawingML effects are rendered. | | get_DmlRenderingMode() const | Gets or sets a value determining how DrawingML shapes are rendered. | | get_ExportGeneratorName() const | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true. | | get_ImlRenderingMode() const | Gets or sets a value determining how ink (InkML) objects are rendered. | | get_MemoryOptimization() const | Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. | | get_PrettyFormat() const | When true, pretty formats output where applicable. Default value is false. | | get_ProgressCallback() const | Called during saving a document and accepts data about saving progress. | | virtual get_SaveFormat() | Specifies the format in which the document will be saved if this save options object is used. | | get_TempFolder() const | Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default, this property is null and no temporary files are used. | | get_UpdateAmbiguousTextFont() const | Determines whether the font attributes will be changed according to the character code being used. | | get_UpdateCreatedTimeProperty() const | Gets or sets a value determining whether the CreatedTime property is updated before saving. Default value is false; | | get_UpdateFields() const | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. | | get_UpdateLastPrintedProperty() const | Gets or sets a value determining whether the LastPrinted property is updated before saving. | | get_UpdateLastSavedTimeProperty() const | Gets or sets a value determining whether the LastSavedTime property is updated before saving. | | get_UpdateOleControlImages() const | Gets a value determining whether OLE controls presentation image will be updated. | | get_UseAntiAliasing() const | Gets or sets a value determining whether or not to use anti-aliasing for rendering. | | get_UseHighQualityRendering() const | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. | | set_AllowEmbeddingPostScriptFonts(bool) | Sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false. | | set_CustomTimeZoneInfo(const System::SharedPtr<System::TimeZoneInfo> &) | Sets custom local time zone used for date/time fields. | | set_DefaultTemplate(const System::String &) | Sets path to default template (including filename). Default value for this property is empty string. | | set_Dml3DEffectsRenderingMode(Aspose::Words::Saving::Dml3DEffectsRenderingMode) | Sets a value determining how 3D effects are rendered. | | virtual set_DmlEffectsRenderingMode(Aspose::Words::Saving::DmlEffectsRenderingMode) | Sets a value determining how DrawingML effects are rendered. | | set_DmlRenderingMode(Aspose::Words::Saving::DmlRenderingMode) | Sets a value determining how DrawingML shapes are rendered. | | set_ExportGeneratorName(bool) | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true. | | set_ImlRenderingMode(Aspose::Words::Saving::ImlRenderingMode) | Sets a value determining how ink (InkML) objects are rendered. | | set_MemoryOptimization(bool) | Sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. | | set_PrettyFormat(bool) | When true, pretty formats output where applicable. Default value is false. | | set_ProgressCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentSavingCallback> &) | Called during saving a document and accepts data about saving progress. | | virtual set_SaveFormat(Aspose::Words::SaveFormat) | Specifies the format in which the document will be saved if this save options object is used. | | set_TempFolder(const System::String &) | Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default, this property is null and no temporary files are used. | | set_UpdateAmbiguousTextFont(bool) | Determines whether the font attributes will be changed according to the character code being used. | | set_UpdateCreatedTimeProperty(bool) | Sets a value determining whether the CreatedTime property is updated before saving. Default value is false; | | set_UpdateFields(bool) | Sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. | | set_UpdateLastPrintedProperty(bool) | Sets a value determining whether the LastPrinted property is updated before saving. | | set_UpdateLastSavedTimeProperty(bool) | Sets a value determining whether the LastSavedTime property is updated before saving. | | set_UpdateOleControlImages(bool) | Sets a value determining whether OLE controls presentation image will be updated. | | set_UseAntiAliasing(bool) | Sets a value determining whether or not to use anti-aliasing for rendering. | | set_UseHighQualityRendering(bool) | Sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |

See Also