Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

MarkdownFenceOptionSchema

Namespace OfficeIMO.MarkdownRenderer
Assembly OfficeIMO.MarkdownRenderer
Modifiers sealed

Declares a host/plugin fence metadata schema for one or more fenced languages.

Inheritance

  • Object
  • MarkdownFenceOptionSchema

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Constructors

public MarkdownFenceOptionSchema(String id, String name, IEnumerable<String> languages, IEnumerable<MarkdownFenceOptionDefinition> definitions) #

Creates a new fence option schema.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
languages System.Collections.Generic.IEnumerable{System.String} requiredposition: 2
definitions System.Collections.Generic.IEnumerable{OfficeIMO.MarkdownRenderer.MarkdownFenceOptionDefinition} requiredposition: 3

Methods

public Boolean HandlesLanguage(String language) #
Returns: Boolean

Returns true when the schema handles the supplied language.

Parameters

language System.String requiredposition: 0
public MarkdownFenceOptionSet Parse(MarkdownCodeFenceInfo fenceInfo) #
Returns: MarkdownFenceOptionSet

Parses the supplied fence metadata according to this schema.

Parameters

fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo requiredposition: 0

Properties

public String Id { get; } #

Stable schema identifier used for registration and diagnostics.

public String Name { get; } #

Friendly schema name.

public IReadOnlyList<String> Languages { get; } #

Fence languages handled by this schema.

public IReadOnlyList<MarkdownFenceOptionDefinition> Definitions { get; } #

All supported option definitions.