API Reference
Class
FrontMatterBlock
YAML front matter block rendered at the beginning of the document.
Inheritance
- MarkdownBlock
- FrontMatterBlock
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method FrontMatterBlock.FromObject
- Method FrontMatterBlock.FromObject``1
- Property MarkdownDoc.DocumentHeader
- Property MarkdownNativeFrontMatterBlock.FrontMatter
Constructors
public FrontMatterBlock() #Methods
public Entry FindEntry(String key, StringComparison comparison = OrdinalIgnoreCase) #Returns:
EntryFinds a front matter entry by key.
Parameters
- key System.String
- comparison System.StringComparison = OrdinalIgnoreCase
public static FrontMatterBlock FromObject(Object data) #Returns:
FrontMatterBlockCreates front matter from an anonymous object or dictionary.
Parameters
- data System.Object
public static FrontMatterBlock FromObject<T>(T data) #Returns:
FrontMatterBlockCreates front matter from a typed object using public readable properties.
Type Parameters
- T
Parameters
- data ``0
public Boolean HasEntry(String key, StringComparison comparison = OrdinalIgnoreCase) #Returns:
BooleanChecks whether the front matter contains an entry with the specified key.
Parameters
- key System.String
- comparison System.StringComparison = OrdinalIgnoreCase
public Boolean TryGetValue<T>(String key, out T value) #Returns:
BooleanGets a typed front matter value by key when available.
Type Parameters
- T
Parameters
- key System.String
- value ``0@
Inherited Methods
public Void Accept(MarkdownVisitor visitor) #Returns:
VoidInherited from MarkdownObject
Parameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #Returns:
IEnumerable<MarkdownObject>Inherited from MarkdownObject
public IEnumerable<MarkdownObject> AncestorsAndSelf() #Returns:
IEnumerable<MarkdownObject>Inherited from MarkdownObject
public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #Returns:
IEnumerable<TObject>Inherited from MarkdownObject
Type Parameters
- TObject
public IEnumerable<MarkdownObject> Descendants() #Returns:
IEnumerable<MarkdownObject>Inherited from MarkdownObject
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public IReadOnlyList<Entry> Entries { get; } #Structured front matter entries in insertion order.
public String RawYaml { get; set; } #Raw YAML payload between the opening and closing front matter fences when parsed from markdown.
public Nullable<MarkdownSourceSpan> BodySourceSpan { get; set; } #Source span for the raw YAML payload between the opening and closing front matter fences.
Inherited Properties
public MarkdownObject Parent { get; } #Inherited from MarkdownObject
public MarkdownDoc Document { get; } #Inherited from MarkdownObject
public MarkdownObject Root { get; } #Inherited from MarkdownObject
public Nullable<Int32> IndexInParent { get; } #Inherited from MarkdownObject
public MarkdownObject PreviousSibling { get; } #Inherited from MarkdownObject
public MarkdownObject NextSibling { get; } #Inherited from MarkdownObject
public Nullable<MarkdownSourceSpan> SourceSpan { get; set; } #Inherited from MarkdownObject
public MarkdownAttributeSet Attributes { get; } #Inherited from MarkdownObject
public IReadOnlyList<MarkdownObject> ChildObjects { get; } #Inherited from MarkdownObject