Themed 2026 Presentation Style Preview

MarkdownFile Class

This class is used to parse metadata from a Markdown file

Definition

Namespace: Sandcastle.Core.Markdown
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.12.18.0
public class MarkdownFile
Inheritance
Object    MarkdownFile

Constructors

MarkdownFile Constructor

Properties

AlternateId This is used to get or set the alternate ID
Filename This read-only property is used to get the filename
Keywords This is used to get a list of the topic keywords
LinkText This is used to get or set the link text
Summary This is used to get or set the summary text
Title This is used to get or set the title
TocTitle This is used to get or set the table of contents title
UniqueId This is used to get or set the unique ID

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GenerateIdFromTitle This is used to generate a content ID from a title
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also