Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MarkdownFenceOptionDefinition

OfficeIMO.MarkdownRenderer

Namespace
OfficeIMO.MarkdownRenderer
Assembly
OfficeIMO.MarkdownRenderer
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Declares one supported fenced metadata option for a host/plugin schema.

Inheritance

  • object
  • MarkdownFenceOptionDefinition

Usage

Explore 5 API references to this type

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

Accepted by parameters 1

Constructors

public MarkdownFenceOptionDefinition(string name, MarkdownFenceOptionValueKind valueKind, IEnumerable<string>? aliases = null, Func<string?, string?>? validator = null) #

Creates a new fence option definition.

Parameters

name string required
valueKind OfficeIMO.MarkdownRenderer.MarkdownFenceOptionValueKind required
aliases System.Collections.Generic.IEnumerable<string>? = null optional
validator System.Func<string?, string?>? = null optional

Methods

public static MarkdownFenceOptionDefinition Boolean(string name, IEnumerable<string>? aliases = null, Func<string?, string?>? validator = null) #

Creates a boolean-valued option definition.

Parameters

name string required
aliases System.Collections.Generic.IEnumerable<string>? = null optional
validator System.Func<string?, string?>? = null optional
public static MarkdownFenceOptionDefinition Int32(string name, IEnumerable<string>? aliases = null, Func<string?, string?>? validator = null) #

Creates an integer-valued option definition.

Parameters

name string required
aliases System.Collections.Generic.IEnumerable<string>? = null optional
validator System.Func<string?, string?>? = null optional
public static MarkdownFenceOptionDefinition String(string name, IEnumerable<string>? aliases = null, Func<string?, string?>? validator = null) #

Creates a string-valued option definition.

Parameters

name string required
aliases System.Collections.Generic.IEnumerable<string>? = null optional
validator System.Func<string?, string?>? = null optional

Properties

public string Name { get; } #

Canonical option name used in parsed results.

public MarkdownFenceOptionValueKind ValueKind { get; } #

Expected metadata value kind.

public IReadOnlyList<string> Aliases { get; } #

All supported names, including the canonical name.