Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

MarkdownFenceOptionDefinition

Edit on GitHub
Namespace OfficeIMO.MarkdownRenderer
Assembly OfficeIMO.MarkdownRenderer
Source ../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:12
Modifiers sealed

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

Inheritance

  • Object
  • MarkdownFenceOptionDefinition

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

Accepted by parameters

Constructors

public MarkdownFenceOptionDefinition(String name, MarkdownFenceOptionValueKind valueKind, IEnumerable<String> aliases = null, Func<String, String> validator = null) #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:12

Creates a new fence option definition.

Parameters

name System.String requiredposition: 0
valueKind OfficeIMO.MarkdownRenderer.MarkdownFenceOptionValueKind requiredposition: 1
aliases System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 2
validator System.Func{System.String,System.String} = null optionalposition: 3

Methods

public static MarkdownFenceOptionDefinition Boolean(String name, IEnumerable<String> aliases = null, Func<String, String> validator = null) #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:63
Returns: MarkdownFenceOptionDefinition

Creates a boolean-valued option definition.

Parameters

name System.String requiredposition: 0
aliases System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 1
validator System.Func{System.String,System.String} = null optionalposition: 2
public static MarkdownFenceOptionDefinition Int32(String name, IEnumerable<String> aliases = null, Func<String, String> validator = null) #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:72
Returns: MarkdownFenceOptionDefinition

Creates an integer-valued option definition.

Parameters

name System.String requiredposition: 0
aliases System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 1
validator System.Func{System.String,System.String} = null optionalposition: 2
public static MarkdownFenceOptionDefinition String(String name, IEnumerable<String> aliases = null, Func<String, String> validator = null) #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:54
Returns: MarkdownFenceOptionDefinition

Creates a string-valued option definition.

Parameters

name System.String requiredposition: 0
aliases System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 1
validator System.Func{System.String,System.String} = null optionalposition: 2

Properties

public String Name { get; } #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:37

Canonical option name used in parsed results.

public MarkdownFenceOptionValueKind ValueKind { get; } #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:40

Expected metadata value kind.

public IReadOnlyList<String> Aliases { get; } #
../../../../_/OfficeIMO.MarkdownRenderer/MarkdownFenceOptionDefinition.cs:43

All supported names, including the canonical name.