Maml |
Renderer for a Markdown MarkdownDocument object that renders into one or multiple MAML files (MAML = Microsoft Assisted Markup Language).
Inheritance HierarchySystemObject
RendererBase
TextRendererBase
TextRendererBaseMamlRenderer
Altaxo.Text.RenderersMamlRenderer
RendererBase
TextRendererBase
TextRendererBaseMamlRenderer
Altaxo.Text.RenderersMamlRenderer
Namespace: Altaxo.Text.Renderers
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class MamlRenderer : TextRendererBase<MamlRenderer>
The MamlRenderer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MamlRenderer | Initializes a new instance of the MamlRenderer class |
Properties| Name | Description | |
|---|---|---|
 | AmlBaseFileName | The basic full path file name of the Maml files. To this name there will be appended (i) a number, and (ii) the extension ".aml". |
| AmlFileNames | Gets all .aml file names that are used here. |
| AutoOutline | If true, an outline of the content will be included at the top of every Maml file. |
| BasePathName | Gets the directory name (this is an absolute path name) that is the directory on which subdirectories like the content directory and the image directory are based. |
| BodyTextFontFamily | Gets or sets the font family of the body text that later on is rendered out of the Maml file. We need this here because we have to convert the formulas to images, and need therefore the image size. |
| BodyTextFontSize | Gets or sets the font size of the body text that later on is rendered out of the Maml file. We need this here because we have to convert the formulas to images, and need therefore the image size. |
| ContentFileNameBase | Gets or sets the base name of .aml files. This property is ignored if the ProjectOrContentFileName itself is a .aml file. |
| ContentFolderName | Name of the folder relative to the help file builder project, in which the content (.aml and .content) is stored. This property is ignored when the ProjectOrContentFileName is not a Sandcastle help file builder project file. |
| ContentLayoutFileName | Gets the full file name of the content layout file (extension: .content), that is a kind of table of contents for the document. |
| EnableHtmlEscape | |
| EnableLinkToNextSection | If true, a link to the next section is inserted at the end of each maml document. |
| EnableLinkToPreviousSection | If true, a link to the previous section is inserted at the beginning of each maml document. |
| FirstHeadingBlockIsParentOfAll | Gets a value indicating whether the very first heading block is the parent of all other heading blocks, i.e. it has the lowest level, and is the only heading block with that level. |
| HeaderGuids | |
| ImageFileNames | Gets all image file names that are used, including the equation images. |
| ImageFolderName | Gets the name of the image folder. This folder, for instance 'Image', is relative to the BasePathName. |
| ImageTopicFileGuid | |
| IsFirstInContainer | (Inherited from RendererBase) |
| IsIntendedForHelp1File | Set this property to true if the Maml is indended to be used in a Help1 file. In such a file, the placement of images with align="middle" differs from HTML rendering (the text baseline is aligned with the middle of the image, whereas in HTML the middle of the text is aligned with the middle of the image). |
| IsLastInContainer | (Inherited from RendererBase) |
| LinkToNextSectionLabelText | Gets or sets the text that is inserted immediately before the link to the next section. |
| LinkToPreviousSectionLabelText | Gets or sets the text that is inserted immediately before the link to the next section. |
| ObjectRenderers | (Inherited from RendererBase) |
| OldToNewImageUris | Dictionary that translates image references currently in the provided markdown file to new image references in the file system. |
| ProjectOrContentFileName | Full name of either the Sandcastle help file builder project (.shfbproj), or the layout content file (.content). |
| SplitLevel | The header level where to split the output into different MAML files. 0 = render in only one file. 1 = Split at header level 1, 2 = split at header level 2, and so on. |
| Writer | (Inherited from TextRendererBase) |
Methods| Name | Description | |
|---|---|---|
| CloseCurrentMamlFile | |
| ElementStackContains | |
| EnsureLine | (Inherited from TextRendererBaseMamlRenderer) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | ExtractContentLayoutFileNameFromShfbproj | Extracts the file name of the content layout file (extension: .content) from the Sandcastle help file builder project. |
| ExtractTextContentFrom | |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindFragmentLink | |
| GetContentLayoutFileName | Gets the name of the content layout file, depending on the file name the user has chosen to be the output file. If the user has chosen a .content file, then this name is returned. If the user has chosen a SHFBPROJ file, then the name of the .content file is extracted from this project file. If all this fails, the name of the content layout file is synthezized from the user chosen file name. |
| GetFileNameRelativeTo | Gets the file name relative to a directory. The returned relative file name is HTML friendly. |
| 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) |
| NumberOfElementsOnStack | |
| Pop | |
| PopAll | |
| PopIndent | (Inherited from TextRendererBaseMamlRenderer) |
| PopTo | |
| PopToBefore | |
| Push(MamlElement) | |
| Push(MamlElement, IEnumerableKeyValuePairString, String) | |
| PushIndent(String) | (Inherited from TextRendererBaseMamlRenderer) |
| PushIndent(String) | (Inherited from TextRendererBaseMamlRenderer) |
| RemoveOldContentsOfContentFolder | Removes the old image files. This function will work only if there is a dedicated image folder, i.e. ImageFileNames has a value. |
| RemoveOldContentsOfImageFolder | Removes the old image files. This function will work only if there is a dedicated image folder, i.e. ImageFileNames has a value. |
| Render | (Overrides TextRendererBase.Render(MarkdownObject)) |
| Reset | (Inherited from TextRendererBaseMamlRenderer) |
| StorePngImageFile | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryStartNewMamlFile | Try to start a new maml file. |
| UpdateShfbproj | Updates the Sandcastle help file builder project file. This update removes old .aml files and old referenced images and replaces them with new .aml files and image files. |
| Write(Char) | (Inherited from TextRendererBaseMamlRenderer) |
| Write(MarkdownObject) | (Inherited from RendererBase) |
| Write(ReadOnlySpanChar) | (Inherited from TextRendererBaseMamlRenderer) |
| Write(String) | (Inherited from TextRendererBaseMamlRenderer) |
| Write(StringSlice) | (Inherited from TextRendererBaseMamlRenderer) |
| Write(StringSlice) | (Inherited from TextRendererBaseMamlRenderer) |
| Write(String, Int32, Int32) | (Inherited from TextRendererBaseMamlRenderer) |
| WriteChildren(ContainerBlock) | (Inherited from RendererBase) |
| WriteChildren(ContainerInline) | (Inherited from RendererBase) |
| WriteContentLayoutFile | Writes the content layout file, i.e. the sections as indicated by the heading levels are written in a XML tree structure to be read by Sandcastle help file builder. |
| WriteEscape(String) | Writes the content escaped for Maml. |
| WriteEscape(StringSlice, Boolean) | Writes the content escaped for Maml. |
| WriteEscape(StringSlice, Boolean) | Writes the content escaped for XAML. |
| WriteEscape(String, Int32, Int32, Boolean) | Writes the content escaped for Maml. |
| WriteImageTopicFile | Writes a file which contains all referenced images in native resolution (without using width and height attributes). Including this file helps to ensure that all referenced images will be included into the help file. |
| WriteLeafInline | (Inherited from TextRendererBaseMamlRenderer) |
| WriteLeafRawLines | Writes the lines of a LeafBlock |
| WriteLine | (Inherited from TextRendererBaseMamlRenderer) |
| WriteLine(Char) | (Inherited from TextRendererBaseMamlRenderer) |
| WriteLine(NewLine) | (Inherited from TextRendererBaseMamlRenderer) |
| WriteLine(String) | (Inherited from TextRendererBaseMamlRenderer) |
Events| Name | Description | |
|---|---|---|
 | ObjectWriteAfter | (Inherited from RendererBase) |
| ObjectWriteBefore | (Inherited from RendererBase) |
Fields| Name | Description | |
|---|---|---|
 | previousWasLine | (Inherited from TextRendererBaseMamlRenderer) |
See Also