Click or drag to resize

MamlRenderer Methods

The MamlRenderer type exposes the following members.

Methods
 NameDescription
Public methodCloseCurrentMamlFile 
Public methodElementStackContains 
Public methodEnsureLine
(Inherited from TextRendererBaseMamlRenderer)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodStatic memberExtractContentLayoutFileNameFromShfbproj Extracts the file name of the content layout file (extension: .content) from the Sandcastle help file builder project.
Public methodExtractTextContentFrom 
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFindFragmentLink 
Public methodGetContentLayoutFileName 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.
Public methodStatic memberGetFileNameRelativeTo Gets the file name relative to a directory. The returned relative file name is HTML friendly.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodNumberOfElementsOnStack 
Public methodPop 
Public methodPopAll 
Public methodPopIndent
(Inherited from TextRendererBaseMamlRenderer)
Public methodPopTo 
Public methodPopToBefore 
Public methodPush(MamlElement) 
Public methodPush(MamlElement, IEnumerableKeyValuePairString, String) 
Public methodPushIndent(String)
(Inherited from TextRendererBaseMamlRenderer)
Public methodPushIndent(String)
(Inherited from TextRendererBaseMamlRenderer)
Public methodStatic memberRemoveOldContentsOfContentFolder Removes the old image files. This function will work only if there is a dedicated image folder, i.e. ImageFileNames has a value.
Public methodStatic memberRemoveOldContentsOfImageFolder Removes the old image files. This function will work only if there is a dedicated image folder, i.e. ImageFileNames has a value.
Public methodRender
(Overrides TextRendererBase.Render(MarkdownObject))
Protected methodReset
(Inherited from TextRendererBaseMamlRenderer)
Public methodStorePngImageFile 
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryStartNewMamlFile Try to start a new maml file.
Public methodStatic memberUpdateShfbproj 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.
Public methodWrite(Char)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWrite(MarkdownObject)
(Inherited from RendererBase)
Public methodWrite(ReadOnlySpanChar)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWrite(String)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWrite(StringSlice)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWrite(StringSlice)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWrite(String, Int32, Int32)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWriteChildren(ContainerBlock)
(Inherited from RendererBase)
Public methodWriteChildren(ContainerInline)
(Inherited from RendererBase)
Public methodWriteContentLayoutFile 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.
Public methodWriteEscape(String) Writes the content escaped for Maml.
Public methodWriteEscape(StringSlice, Boolean) Writes the content escaped for Maml.
Public methodWriteEscape(StringSlice, Boolean) Writes the content escaped for XAML.
Public methodWriteEscape(String, Int32, Int32, Boolean) Writes the content escaped for Maml.
Public methodWriteImageTopicFile 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.
Public methodWriteLeafInline
(Inherited from TextRendererBaseMamlRenderer)
Public methodWriteLeafRawLines Writes the lines of a LeafBlock
Public methodWriteLine
(Inherited from TextRendererBaseMamlRenderer)
Public methodWriteLine(Char)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWriteLine(NewLine)
(Inherited from TextRendererBaseMamlRenderer)
Public methodWriteLine(String)
(Inherited from TextRendererBaseMamlRenderer)
Top
See Also