MarkdownLoadOptions
Contents
[
Hide
]MarkdownLoadOptions class
Allows to specify additional options when loading Markdown document into a Document object.
public class MarkdownLoadOptions : LoadOptions
Constructors
| Name | Description |
|---|---|
| MarkdownLoadOptions() | Initializes a new instance of MarkdownLoadOptions class. |
Properties
| Name | Description |
|---|---|
| BaseUri { get; set; } | Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be null or empty string. Default is null. |
| ConvertMetafilesToPng { get; set; } | Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format. |
| ConvertShapeToOfficeMath { get; set; } | Gets or sets whether to convert shapes with EquationXML to Office Math objects. |
| Encoding { get; set; } | Gets or sets the encoding that will be used to load an HTML, TXT, or CHM document if the encoding is not specified inside the document. Can be null. Default is null. |
| FontSettings { get; set; } | Allows to specify document font settings. |
| IgnoreOleData { get; set; } | Specifies whether to ignore the OLE data. |
| ImportUnderlineFormatting { get; set; } | Gets or sets a boolean value indicating either to recognize a sequence of two plus characters “++” as underline text formatting. The default value is false. |
| LanguagePreferences { get; } | Gets language preferences that will be used when document is loading. |
| LoadFormat { get; set; } | Specifies the format of the document to be loaded. Default is Auto. |
| MswVersion { get; set; } | Allows to specify that the document loading process should match a specific MS Word version. Default value is Word2019 |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. Can be null or empty string. Default is null. |
| PreserveEmptyLines { get; set; } | Gets or sets a boolean value indicating whether to preserve empty lines while load a Markdown document. The default value is false. |
| PreserveIncludePictureField { get; set; } | Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is false. |
| ProgressCallback { get; set; } | Called during loading a document and accepts data about loading progress. |
| ResourceLoadingCallback { get; set; } | Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. |
| TempFolder { get; set; } | Allows to use temporary files when reading document. By default this property is null and no temporary files are used. |
| UpdateDirtyFields { get; set; } | Specifies whether to update the fields with the dirty attribute. |
| UseSystemLcid { get; set; } | Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins. |
| WarningCallback { get; set; } | Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss. |
Methods
| Name | Description |
|---|---|
| override Equals(object) | Determines whether the specified object is equal in value to the current object. |
Examples
Shows how to preserve empty line while load a document.
string mdText = $"{Environment.NewLine}Line1{Environment.NewLine}{Environment.NewLine}Line2{Environment.NewLine}{Environment.NewLine}";
using (MemoryStream stream = new MemoryStream(Encoding.UTF8.GetBytes(mdText)))
{
MarkdownLoadOptions loadOptions = new MarkdownLoadOptions() { PreserveEmptyLines = true };
Document doc = new Document(stream, loadOptions);
Assert.AreEqual("\rLine1\r\rLine2\r\f", doc.GetText());
}
See Also
- class LoadOptions
- namespace Aspose.Words.Loading
- assembly Aspose.Words