Click or drag to resize

HtmlSplitRenderer Class

Renderer which renders into multiple Htlm files, including a table of contents file.
Inheritance Hierarchy
SystemObject
  Altaxo.Text.Renderers.HtmlHtmlSplitRenderer

Namespace: Altaxo.Text.Renderers.Html
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class HtmlSplitRenderer

The HtmlSplitRenderer type exposes the following members.

Constructors
 NameDescription
Public methodHtmlSplitRendererInitializes a new instance of the HtmlSplitRenderer class
Top
Properties
 NameDescription
Public propertyAutoOutline If true, an outline of the content will be included at the top of every Html file.
Public propertyBasePathName 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.
Public propertyBodyTextFontFamily 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.
Public propertyBodyTextFontSize 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.
Public propertyContentFileNameBase Gets or sets the base name of .aml files.
Public propertyContentFolderName Name of the folder relative to the help file builder project, in which the content (.aml and .content) is stored.
Public propertyEnableHtmlEscape 
Public propertyEnableLinkToNextSection If true, a link to the next section is inserted at the end of each maml document.
Public propertyEnableLinkToPreviousSection If true, a link to the previous section is inserted at the beginning of each maml document.
Public propertyEnableLinkToTableOfContents If true, a link to the table of contents is inserted at the end of each maml document.
Public propertyFirstHeadingBlockIsParentOfAll 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.
Public propertyHeaderGuids 
Public propertyHtmlBaseFileName The basic full path file name of the Html files. To this name there will be appended (i) a number, and (ii) the extension ".html".
Public propertyHtmlFileNames Gets all .aml file names that are used here.
Public propertyImageFileNames Gets all image file names that are used, including the equation images.
Public propertyImageFolderName Gets the name of the image folder. This folder, for instance 'Image', is relative to the BasePathName.
Public propertyLinkToNextSectionLabelText Gets or sets the text that is inserted immediately before the link to the next section.
Public propertyLinkToPreviousSectionLabelText Gets or sets the text that is inserted immediately before the link to the next section.
Public propertyLinkToTableOfContentsLabelText Gets or sets the text that is inserted in the link to the table of contents.
Public propertyOldToNewImageUris Dictionary that translates image references currently in the provided markdown file to new image references in the file system.
Public propertySplitLevel 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.
Top
Methods
 NameDescription
Public methodBuildHtmlRenderer Builds the HTML renderer.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
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 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 methodStatic memberRemoveOldContentsOfContentFolder 
Public methodStatic memberRemoveOldContentsOfImageFolder 
Public methodRender 
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also