MarkdownSaveOptions
OfficeIMO.Markdown
Options controlling markdown serialization from the typed document model.
Inheritance
- object
- MarkdownSaveOptions
Usage
Explore 17 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 9
- Property MarkdownInlineMarkdownRenderContext.Options
- Method MarkdownSaveOptions.Clone
- Method MarkdownSaveOptions.CreateCommonMarkProfile
- Method MarkdownSaveOptions.CreateGitHubFlavoredMarkdownProfile
- Method MarkdownSaveOptions.CreateHtmlImageProfile
- Method MarkdownSaveOptions.CreateOfficeIMOProfile
- Method MarkdownSaveOptions.CreatePortableProfile
- Method MarkdownSaveOptions.CreateProfile
- Property MarkdownWriteContext.Options
Accepted by parameters 8
- Method MarkdownBlockMarkdownRenderer.BeginInvoke
- Method MarkdownBlockMarkdownRenderer.Invoke
- Method MarkdownDocument.Save
- Method MarkdownDocument.SaveAsync
- Method MarkdownDocument.ToBytes
- Method MarkdownDocument.ToMarkdown
- Method MarkdownInlineMarkdownRenderer.BeginInvoke
- Method MarkdownInlineMarkdownRenderer.Invoke
Constructors
public MarkdownSaveOptions() #Methods
public MarkdownSaveOptions Clone() #Creates a shallow clone of the writer options while copying mutable collections.
Returns
MarkdownSaveOptionspublic static MarkdownSaveOptions CreateCommonMarkProfile() #Creates a CommonMark-oriented writer profile. GitHub-only constructs such as pipe tables are emitted using portable raw HTML fallbacks when a plain CommonMark representation does not exist.
Returns
MarkdownSaveOptionspublic static MarkdownSaveOptions CreateGitHubFlavoredMarkdownProfile() #Creates a GitHub Flavored Markdown-oriented writer profile for README and GitHub documentation output.
Returns
MarkdownSaveOptionspublic static MarkdownSaveOptions CreateHtmlImageProfile() #Creates a markdown writer profile that emits raw HTML for image output.
Returns
MarkdownSaveOptionspublic static MarkdownSaveOptions CreateOfficeIMOProfile() #Creates default OfficeIMO-flavored markdown writer options.
Returns
MarkdownSaveOptionspublic static MarkdownSaveOptions CreatePortableProfile() #Creates a more portable markdown writer profile that degrades OfficeIMO-only blocks into broadly compatible markdown.
Returns
MarkdownSaveOptionspublic static MarkdownSaveOptions CreateProfile(MarkdownOutputProfile profile) #Creates writer options for the requested output profile.
Parameters
- profile OfficeIMO.Markdown.MarkdownOutputProfile
Returns
MarkdownSaveOptionsInherited Methods
Properties
public bool AllowLoss { get; set; } #Accepts native-save omissions explicitly selected by the writer options.
public Encoding? Encoding { get; set; } #Output encoding, or null for UTF-8 without a byte-order mark.
public MarkdownImageRenderingMode ImageRenderingMode { get; set; } #Controls how image blocks and image inlines are serialized back to markdown text.
public MarkdownTextEscapingMode TextEscapingMode { get; set; } #Controls escaping of literal inline text and unstructured table strings. The default preserves existing output. MarkdownTextEscapingMode.LiteralBackslash prevents HTML and entity interpretation without introducing HTML character references or escaping ordinary parentheses.
public MarkdownFrontMatterRenderingMode FrontMatterRendering { get; set; } #Controls how YAML front matter is emitted by MarkdownDocument.ToMarkdown.
public MarkdownAbbreviationDefinitionRenderingMode AbbreviationDefinitionRendering { get; set; } #Controls how parse-owned abbreviation definitions are emitted by MarkdownDocument.ToMarkdown.
public string? OutputLineEnding { get; set; } #Optional line ending to use in rendered Markdown. When unset, the platform default is used.
public char UnorderedListMarker { get; set; } #Marker used when rendering unordered list items. CommonMark-compatible values are -, *, and +.
public List<MarkdownBlockMarkdownRenderExtension> BlockRenderExtensions { get; } #Optional markdown block render extensions. Later registrations win when block types overlap.
public List<MarkdownInlineMarkdownRenderExtension> InlineRenderExtensions { get; } #Optional markdown inline render extensions. Later registrations win when inline types overlap.
public List<MarkdownSyntaxBlockMarkdownRenderExtension> SyntaxBlockRenderExtensions { get; } #Optional markdown block render extensions that match parsed blocks by final syntax kind. Later registrations win when syntax kinds overlap. These extensions run before type-based block extensions.
public List<MarkdownSyntaxInlineMarkdownRenderExtension> SyntaxInlineRenderExtensions { get; } #Optional markdown inline render extensions that match parsed inlines by final syntax kind. Later registrations win when syntax kinds overlap. These extensions run before type-based inline extensions.