Maml |
The MamlRenderer type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CloseCurrentMamlFile | Closes the current MAML topic file after writing any deferred navigation links. |
| ElementStackContains | Determines whether the element stack contains the specified element. |
| 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 | Extracts the text content from the specified leaf block. |
 | 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 | Finds a fragment link target inside the rendered MAML files. |
| 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 synthesized 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 | Gets the number of times the specified element appears on the stack. |
| Pop | Pops the top Maml element from the stack. |
| PopAll | Pops all elements from the current element stack. |
| PopIndent | (Inherited from TextRendererBaseMamlRenderer) |
| PopTo | Pops elements from the stack until the specified element is found and popped. |
| PopToBefore | Pops elements from the stack until just before the specified element is on top. |
| Push(MamlElement) | Pushes a Maml element onto the stack. |
| Push(MamlElement, IEnumerableKeyValuePairString, String) | Pushes a Maml element with attributes onto the stack. |
| PushIndent(String) | (Inherited from TextRendererBaseMamlRenderer) |
| PushIndent(String) | (Inherited from TextRendererBaseMamlRenderer) |
| RemoveOldContentsOfContentFolder | Removes the old content files from the content folder. |
| 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 | Stores a PNG image stream in the configured image folder. |
| 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) |
See Also