Html |
Options to export a TextDocument into one or multiple Html file(s), including all the referenced graphs and local images.
Inheritance HierarchyNamespace: Altaxo.Text
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class HtmlExportOptions : ICloneable
The HtmlExportOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HtmlExportOptions | Initializes a new instance of the HtmlExportOptions class |
Properties| Name | Description | |
|---|---|---|
 | BodyTextFontFamily | Gets or sets the font family of the body text that later on is rendered out of the Html 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 Html file. We need this here because we have to convert the formulas to images, and need therefore the image size. |
| EnableHtmlEscape | |
| EnableLinkToNextSection | If true, a link to the next section is inserted at the end of each Html document. |
| EnableLinkToPreviousSection | If true, a link to the previous section is inserted at the beginning of each Html document. |
| EnableLinkToTableOfContents | If true, a link to the next section is inserted at the end of each Html document. |
| EnableRemoveOldContentsOfImageFolder | If set to true, all files residing in the image folder are deleted before exporting the new image files. |
| EnableRemoveOldContentsOfOutputFolder | If set to true, all .html files residing in the output directory will be removed before exporting. |
| ExpandChildDocuments | If true, included child documents are expanded before the markdown document is processed. |
| ImageFolderName | Gets or sets the name of the image folder. This folder, for instance 'Image', is relative to the folder where the output file(s) are located. |
| 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. |
| LinkToTableOfContentsLabelText | Gets or sets the text that is inserted immediately before the link to the next section. |
| OpenHtmlViewer | If true, the default Htlm viewer application is opened after the Html files were exported. |
| OutputFileName | Gets or sets the output file. This is the base name, which is amended with numbers. |
| RenumerateFigures | If true, figures will be renumerated and the links to those figures updated. |
| SplitLevel | The header level where to split the output into different Html files. 0 = render in only one file. 1 = Split at header level 1, 2 = split at header level 2, and so on. |
Methods| Name | Description | |
|---|---|---|
| Clone | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Export | Exports the specified TextDocument to an external markdown file. |
 | ExportShowDialog | Exports the TextDocument to a markdown file, showing first the file save dialog. |
 | 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) |
| ShowGetOutputFileDialog | Gets the output file by showing a save file dialog. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
 | _bodyTextFontFamily | Gets or sets the font family of the body text that later on is rendered out of the Html file. We need this here because we have to convert the formulas to images, and need therefore the image size. |
| _imageFolderName | Name of the folder relative to the markdown document, in which the images (graphs and local images) are stored. |
| _splitLevel | The header level where to split the output into different Html files. 0 = render in only one file. 1 = Split at header level 1, 2 = split at header level 2, and so on. |
 | PropertyKeyHtmlExportOptions |
See Also