Markdown
This class is used to generate a Markdown topic from a MAML topic for the Markdown conversion presentation
style by utilizing the existing parsing and rendering features of the presentation style transformation.
Definition
Namespace: Sandcastle.Core.PresentationStyle.Conversion
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.12.18.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.12.18.0
C#
public class MarkdownConversionTransformation : TopicTransformationCoreVB
Public Class MarkdownConversionTransformation
Inherits TopicTransformationCoreC++
public ref class MarkdownConversionTransformation : public TopicTransformationCoreF#
type MarkdownConversionTransformation =
class
inherit TopicTransformationCore
end- Inheritance
- Object TopicTransformationCore MarkdownConversionTransformation
Constructors
| MarkdownConversionTransformation | Constructor |
Properties
| ApiMember |
This read-only property returns common API member information for the API topic being rendered. This
is not used for MAML topics.
(Inherited from TopicTransformationCore) |
| ApiTopicSections |
This read-only property returns an enumerable list of the API section handlers in the order that they
will be rendered
(Inherited from TopicTransformationCore) |
| BibliographyData |
This read-only property returns the content of the bibliography data file if a
BibliographyDataFile has been specified.
(Inherited from TopicTransformationCore) |
| BibliographyDataFile |
This is used to get or set the path to the bibliography data file for the bibliography
and cite elements.
(Inherited from TopicTransformationCore) |
| CodeSnippetLanguageConversion |
This read-only property returns a dictionary containing code snippet language ID conversions
(Inherited from TopicTransformationCore) |
| CommentsNode |
This read-only property returns the comments node for the API topic being rendered. This is
not used for MAML topics.
(Inherited from TopicTransformationCore) |
| CurrentElement |
This is used to get or set the current element to which rendered content is being added
(Inherited from TopicTransformationCore) |
| DocumentNode |
This read-only property returns the root document node for the topic being rendered
(Inherited from TopicTransformationCore) |
| HasFooterContent |
This property is used to get or set whether or not all pages should be have the footer content item
inserted into them.
(Inherited from TopicTransformationCore) |
| HasHeaderText |
This property is used to get or set whether or not all pages should be have the header text item
inserted into them.
(Inherited from TopicTransformationCore) |
| HasWebsiteAdContent |
This property is used to get or set whether or not all pages should be have the website ad content
item inserted into them.
(Inherited from TopicTransformationCore) |
| HtmlBlockAndDoNotParseTags |
This read-only property is used to obtain an enumerable list of HTML block tags and those that should
not be parsed.
(Inherited from TopicTransformationCore) |
| IconPath |
This is used to get or set the path used for icons and other images in the presentation style
(Overrides TopicTransformationCoreIconPath) |
| IsMamlTopic |
This read-only property returns true if a MAML topic is being generated, false if an API topic is
being generated
(Inherited from TopicTransformationCore) |
| IsPreliminaryDocumentation |
This property is used to get or set whether or not all pages should be marked with a "preliminary
documentation" warning in the page header.
(Inherited from TopicTransformationCore) |
| Key |
This read-only property returns the topic key
(Inherited from TopicTransformationCore) |
| LanguageFilter |
This read-only property returns the language filter items for presentation styles that contain one
in their topics.
(Inherited from TopicTransformationCore) |
| Locale |
This is used to get or set the locale
(Inherited from TopicTransformationCore) |
| MetadataNode |
This read-only property returns the metadata node for the topic being rendered
(Inherited from TopicTransformationCore) |
| NoticeDefinitions |
This read-only property returns an enumerable list of the notice definitions
(Inherited from TopicTransformationCore) |
| ReferenceNode |
This read-only property returns the reference node for the API topic being rendered. This is
not used for MAML topics.
(Inherited from TopicTransformationCore) |
| ResolvePath |
This read-only property is used to get the function use to resolve a path to a presentation style
content file of some sort.
(Inherited from TopicTransformationCore) |
| ScriptPath |
This is used to get or set the path used for scripts in the presentation style
(Overrides TopicTransformationCoreScriptPath) |
| StartupScriptBlockItemIds |
This read-only property returns an enumerable list of the startup script block item IDs that have
been registered.
(Inherited from TopicTransformationCore) |
| StartupScriptBlocks |
This read-only property returns an enumerable list of the startup script blocks that have been
registered.
(Inherited from TopicTransformationCore) |
| StyleSheetPath |
This is used to get or set the path used for style sheets in the presentation style
(Overrides TopicTransformationCoreStyleSheetPath) |
| SupportedFormats |
This read-only property returns the help file formats supported by the presentation style
(Inherited from TopicTransformationCore) |
| SyntaxNode |
This read-only property returns the syntax node for the API topic being rendered. This is
not used for MAML topics.
(Inherited from TopicTransformationCore) |
| TopicNode |
This read-only property returns the topic node for the MAML topic being rendered. This is
not used for API topics.
(Inherited from TopicTransformationCore) |
| TopicTemplatePath |
This is used to get or set the topic template path if the presentation style makes use of one
(Inherited from TopicTransformationCore) |
| TransformationArguments |
This read-only property returns a dictionary used to contain transformation arguments used by the
presentation style
(Inherited from TopicTransformationCore) |
| UsesLegacyCodeColorizer |
This property is used to get or set whether or not the presentation style transformation uses
the legacy code colorizer.
(Inherited from TopicTransformationCore) |
Methods
| AddApiTopicSectionHandler |
Add a new API topic section handler
(Inherited from TopicTransformationCore) |
| AddApiTopicSectionHandlerRange |
Add a range of new API topic section handlers
(Inherited from TopicTransformationCore) |
| AddElement |
Add an element that will be transformed when the topic is rendered
(Inherited from TopicTransformationCore) |
| AddElements |
Add a range of elements that will be transformed when the topic is rendered
(Inherited from TopicTransformationCore) |
| AddLanguageFilterItems |
This is used to add the language filter item information for presentation styles that contain a
language filter in the topics.
(Inherited from TopicTransformationCore) |
| AddLanguageSpecificText |
Add a language specific text entry
(Inherited from TopicTransformationCore) |
| AddLanguageSpecificTextRange |
Add a range of language specific text entries
(Inherited from TopicTransformationCore) |
| AddNoticeDefinition |
Add a notice definitions
(Inherited from TopicTransformationCore) |
| AddNoticeDefinitions |
Add one or more notice definitions
(Inherited from TopicTransformationCore) |
| AddTransformationArgument |
Add a new transformation argument
(Inherited from TopicTransformationCore) |
| AddTransformationArgumentRange |
Add a range of new transformation arguments
(Inherited from TopicTransformationCore) |
| ApiTopicOperatorTypes |
Get parameter and return types for an operator API member topic (e.g. Int32 to Decimal)
(Inherited from TopicTransformationCore) |
| ApiTopicParameterTypes |
Get parameter types for an API member topic in plain text format
(Inherited from TopicTransformationCore) |
| ApiTopicSectionHandlerFor |
This is used to retrieve the current API topic section handler for the given section
(Inherited from TopicTransformationCore) |
| ApiTopicShortNameDecorated |
Get the short type/member name for an API topic decorated with language-specific text. This is used
for page title.
(Inherited from TopicTransformationCore) |
| ApiTopicShortNamePlainText |
Get the short type/member name for an API topic in plain text. This is used for metadata values and
the table of contents title.
(Inherited from TopicTransformationCore) |
| ApiTopicTitle |
Get the title for an API topic
(Inherited from TopicTransformationCore) |
| ApiTopicTocTitleSimple |
Get the simple table of contents title for an API topic
(Inherited from TopicTransformationCore) |
| ApiTypeNameDecorated |
This is used to get a type name in decorated with language-specific text elements based on the given
type information.
(Inherited from TopicTransformationCore) |
| ApiTypeNamePlainText |
This is used to get a type name in plain text based on the given type information
(Inherited from TopicTransformationCore) |
| CreateApiTopicSectionHandlers |
This is called to create the API topic section handlers that will be used by the transformation
(Overrides TopicTransformationCoreCreateApiTopicSectionHandlers) |
| CreateElementHandlers |
This is called to create the element handlers that will be used by the transformation
(Overrides TopicTransformationCoreCreateElementHandlers) |
| CreateLanguageSpecificText |
This is called to create the language specific text elements that will be used by the transformation
(Overrides TopicTransformationCoreCreateLanguageSpecificText) |
| CreateNoticeDefinitions |
This is called to create the API topic notice definitions that will be used by the transformation
(Overrides TopicTransformationCoreCreateNoticeDefinitions) |
| CreateSection |
Create a topic section with a title
(Overrides TopicTransformationCoreCreateSection(String, Boolean, String, String, Int32)) |
| CreateSubsection |
Create a topic subsection with a title
(Overrides TopicTransformationCoreCreateSubsection(Boolean, String)) |
| CreateTransformationArguments |
This is called to create the transformation arguments that will be used by the transformation
(Overrides TopicTransformationCoreCreateTransformationArguments) |
| ElementHandlerFor |
This is used to retrieve the current handler for the given element name
(Inherited from TopicTransformationCore) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| 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) |
| InsertApiTopicSectionHandlerAfter |
Insert an API topic section handler after the given section handler
(Inherited from TopicTransformationCore) |
| InsertApiTopicSectionHandlerBefore |
Insert an API topic section handler before the given section handler
(Inherited from TopicTransformationCore) |
| LanguageSpecificApiNames |
This returns an enumerable list of plain text API member names with language-specific text for use
in help index entries.
(Inherited from TopicTransformationCore) |
| LanguageSpecificTextFor |
This is used to retrieve the language specific text for a given keyword
(Inherited from TopicTransformationCore) |
| MamlTopicTitle |
Get the title for a MAML topic
(Inherited from TopicTransformationCore) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnRenderCompleted |
This is used to raise the RenderCompleted event
(Inherited from TopicTransformationCore) |
| OnRenderStarting |
This is used to raise the RenderStarting event
(Inherited from TopicTransformationCore) |
| OnSectionRendered |
This is used to raise the SectionRendered event
(Inherited from TopicTransformationCore) |
| OnUnhandledElement |
This is used to raise the UnhandledElement event
(Inherited from TopicTransformationCore) |
| RegisterStartupScript |
This is used to register a block of script to execute in the $(document).ready() function by
presentation styles that support script.
(Inherited from TopicTransformationCore) |
| RegisterStartupScriptItem |
This is used to register a shared content item ID that contains a block of script with localized
text. These will be added to a script element at the end of the document body by presentation
styles that support script.
(Inherited from TopicTransformationCore) |
| RemoveApiTopicSectionHandler |
Remove an API topic section handler
(Inherited from TopicTransformationCore) |
| Render |
This is used to parse the topic data and render the topic output for the presentation style
(Inherited from TopicTransformationCore) |
| RenderChildElements |
This makes the given parent element the current element, renders the list of children to it and then
resets the current element to the prior current element.
(Inherited from TopicTransformationCore) |
| RenderNode |
Render the given XML node based on its node type
(Overrides TopicTransformationCoreRenderNode(XNode)) |
| RenderTextNode |
This is used to provide additional whitespace handling and normalization for markdown elements
(Overrides TopicTransformationCoreRenderTextNode(XElement, XText)) |
| RenderTopic |
Render the topic content based on the topic type
(Overrides TopicTransformationCoreRenderTopic) |
| RenderTypeReferenceLink |
This is used to render a reference link based on the given type information
(Inherited from TopicTransformationCore) |
| ReplaceApiTopicSectionHandler |
Replace an API topic section handler with a new one
(Inherited from TopicTransformationCore) |
| ReplaceElement |
Replace an element handler
(Inherited from TopicTransformationCore) |
| ReplaceElements |
Replace a range of elements
(Inherited from TopicTransformationCore) |
| ReplaceLanguageSpecificText |
Replace a language specific text entry
(Inherited from TopicTransformationCore) |
| ReplaceLanguageSpecificTextRange |
Replace a range of language specific text entries
(Inherited from TopicTransformationCore) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events
| RenderCompleted |
This event is raised to notify the user that the topic has been completely rendered
(Inherited from TopicTransformationCore) |
| RenderStarting |
This event is raised to notify the user that the topic is about to be rendered
(Inherited from TopicTransformationCore) |
| SectionRendered |
This event is raised to notify the user of section having been rendered
(Inherited from TopicTransformationCore) |
| UnhandledElement |
This event is raised to notify the user of an unhandled element
(Inherited from TopicTransformationCore) |