Maml
This is a modified version of the HTML renderer that converts a markdown file to a MAML topic for the
Sandcastle Help File Builder build process.
Definition
Namespace: Sandcastle.Core.Markdown.Renderers
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.3.29.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.3.29.0
C#
public class MamlTopicRenderer : HtmlRendererVB
Public Class MamlTopicRenderer
Inherits HtmlRendererC++
public ref class MamlTopicRenderer : public HtmlRendererF#
type MamlTopicRenderer =
class
inherit HtmlRenderer
end- Inheritance
- Object RendererBase TextRendererBase TextRendererBaseHtmlRenderer HtmlRenderer MamlTopicRenderer
Remarks
The result is not a pure MAML document but rather a hybrid of MAML and HTML that can be parsed
and rendered to a supported output format by a Sandcastle Help File Builder presentation style.
Constructors
| MamlTopicRenderer | Constructor |
Properties
| BaseUrl |
Gets a value to use as the base url for all relative links
(Inherited from HtmlRenderer) |
| EnableHtmlEscape | (Inherited from HtmlRenderer) |
| EnableHtmlForBlock |
Gets or sets a value indicating whether to output HTML tags when rendering. See remarks.
(Inherited from HtmlRenderer) |
| EnableHtmlForInline |
Gets or sets a value indicating whether to output HTML tags when rendering. See remarks.
(Inherited from HtmlRenderer) |
| Id | This is used to get or set the current topic ID |
| ImplicitParagraph |
Gets or sets a value indicating whether to use implicit paragraph (optional <p>)
(Inherited from HtmlRenderer) |
| IsFirstInContainer | (Inherited from RendererBase) |
| IsLastInContainer | (Inherited from RendererBase) |
| LinkRewriter |
Allows links to be rewritten
(Inherited from HtmlRenderer) |
| ObjectRenderers | (Inherited from RendererBase) |
| UseNonAsciiNoEscape | (Inherited from HtmlRenderer) |
| Writer |
Gets or sets the writer.
(Inherited from TextRendererBase) |
Methods
| EnsureLine |
Ensures a newline.
(Inherited from TextRendererBaseHtmlRenderer) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| PopIndent | (Inherited from TextRendererBaseHtmlRenderer) |
| PushIndent(String) | (Inherited from TextRendererBaseHtmlRenderer) |
| PushIndent(String) | (Inherited from TextRendererBaseHtmlRenderer) |
| Render |
Renders the specified markdown object (returns the Writer as a render object).
(Overrides TextRendererBase.Render(MarkdownObject)) |
| Reset | (Inherited from TextRendererBaseHtmlRenderer) |
| ResetRenderer | This is used to reset the renderer |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Write(Char) |
Writes the specified character.
(Inherited from TextRendererBaseHtmlRenderer) |
| Write(MarkdownObject) |
Writes the specified Markdown object.
(Inherited from RendererBase) |
| Write(ReadOnlySpanChar) |
Writes the specified content.
(Inherited from TextRendererBaseHtmlRenderer) |
| Write(String) |
Writes the specified content.
(Inherited from TextRendererBaseHtmlRenderer) |
| Write(StringSlice) |
Writes the specified slice.
(Inherited from TextRendererBaseHtmlRenderer) |
| Write(StringSlice) |
Writes the specified slice.
(Inherited from TextRendererBaseHtmlRenderer) |
| Write(String, Int32, Int32) |
Writes the specified content.
(Inherited from TextRendererBaseHtmlRenderer) |
| WriteAttributes(MarkdownObject) |
Writes the attached HtmlAttributes on the specified MarkdownObject.
(Inherited from HtmlRenderer) |
| WriteAttributes(HtmlAttributes, FuncString, String) |
Writes the specified HtmlAttributes.
(Inherited from HtmlRenderer) |
| WriteChildren(ContainerBlock) |
Writes the children of the specified ContainerBlock.
(Inherited from RendererBase) |
| WriteChildren(ContainerInline) |
Writes the children of the specified ContainerInline.
(Inherited from RendererBase) |
| WriteEscape(String) |
Writes the content escaped for HTML.
(Inherited from HtmlRenderer) |
| WriteEscape(ReadOnlySpanChar, Boolean) |
Writes the content escaped for HTML.
(Inherited from HtmlRenderer) |
| WriteEscape(StringSlice, Boolean) |
Writes the content escaped for HTML.
(Inherited from HtmlRenderer) |
| WriteEscape(StringSlice, Boolean) |
Writes the content escaped for HTML.
(Inherited from HtmlRenderer) |
| WriteEscape(String, Int32, Int32, Boolean) |
Writes the content escaped for HTML.
(Inherited from HtmlRenderer) |
| WriteEscapeUrl |
Writes the URL escaped for HTML.
(Inherited from HtmlRenderer) |
| WriteLeafInline |
Writes the inlines of a leaf inline.
(Inherited from TextRendererBaseHtmlRenderer) |
| WriteLeafRawLines |
Writes the lines of a LeafBlock (Inherited from HtmlRenderer) |
| WriteLine |
Writes a newline.
(Inherited from TextRendererBaseHtmlRenderer) |
| WriteLine(Char) |
Writes a content followed by a newline.
(Inherited from TextRendererBaseHtmlRenderer) |
| WriteLine(NewLine) |
Writes a newline.
(Inherited from TextRendererBaseHtmlRenderer) |
| WriteLine(String) |
Writes a content followed by a newline.
(Inherited from TextRendererBaseHtmlRenderer) |
Events
| ObjectWriteAfter |
Occurs when after writing an object.
(Inherited from RendererBase) |
| ObjectWriteBefore |
Occurs when before writing an object.
(Inherited from RendererBase) |
Fields
| previousWasLine | (Inherited from TextRendererBaseHtmlRenderer) |