Maml |
Options to export a TextDocument into one or multiple Maml 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 MamlExportOptions : ICloneable
The MamlExportOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MamlExportOptions | Initializes a new instance of the MamlExportOptions class |
Properties| Name | Description | |
|---|---|---|
 | 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 OutputFileName 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 OutputFileName is not a Sandcastle help file builder project file. |
| EnableAutoOutline | If true, an outline of the content will be included at the top of every Maml file. |
| 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. |
| EnableRemoveOldContentsOfContentFolder | If set to true, all .aml files and all .content files residing in the content folder are deleted before exporting the new image files. |
| EnableRemoveOldContentsOfImageFolder | If set to true, all files residing in the image folder are deleted before exporting the new image files. |
| 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 sandcastle project file is located. |
| IsIntendedForHtmlHelp1File | Set this field 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). |
| 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. |
| OpenHelpFileBuilder | If true, the Help file builder application is opened after the maml files were exported. |
| OutputFileName | Gets or sets the output file. This is preferably a Sandcastle help file builder project file, but can also be a layout content file (.content) or a Maml file (.aml). |
| RenumerateFigures | If true, the figures are renumerated before the markdown document is exported. |
| 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. |
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 Maml 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 MAML files. 0 = render in only one file. 1 = Split at header level 1, 2 = split at header level 2, and so on. |
 | PropertyKeyMamlExportOptions |
See Also