Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

MarkdownRendererFeaturePack

Namespace OfficeIMO.MarkdownRenderer
Assembly OfficeIMO.MarkdownRenderer
Modifiers sealed

Reusable host-level feature pack that can apply a coordinated set of renderer plugins, preprocessors, postprocessors, and option defaults in one idempotent step.

Inheritance

  • Object
  • MarkdownRendererFeaturePack

Usage

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

Accepted by parameters

Constructors

MarkdownRendererFeaturePack 2 overloads
public MarkdownRendererFeaturePack(String id, String name, Action<MarkdownRendererOptions> apply, Action<MarkdownReaderOptions> applyReader = null) #

Creates a new host-level feature pack.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
apply System.Action{OfficeIMO.MarkdownRenderer.MarkdownRendererOptions} requiredposition: 2
applyReader System.Action{OfficeIMO.Markdown.MarkdownReaderOptions} = null optionalposition: 3
public MarkdownRendererFeaturePack(String id, String name, IEnumerable<MarkdownRendererPlugin> plugins, Action<MarkdownRendererOptions> apply = null, Action<MarkdownReaderOptions> applyReader = null) #

Creates a new host-level feature pack from reusable plugins plus an optional custom apply step.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
plugins System.Collections.Generic.IEnumerable{OfficeIMO.MarkdownRenderer.MarkdownRendererPlugin} requiredposition: 2
apply System.Action{OfficeIMO.MarkdownRenderer.MarkdownRendererOptions} = null optionalposition: 3
applyReader System.Action{OfficeIMO.Markdown.MarkdownReaderOptions} = null optionalposition: 4

Methods

public Void Apply(MarkdownRendererOptions options) #
Returns: Void

Applies the feature pack once to the supplied renderer options.

Parameters

options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions requiredposition: 0
public Boolean IsApplied(MarkdownRendererOptions options) #
Returns: Boolean

Returns true when the feature pack has already been applied.

Parameters

options OfficeIMO.MarkdownRenderer.MarkdownRendererOptions requiredposition: 0

Properties

public String Id { get; } #

Stable feature-pack identifier used for idempotence and diagnostics.

public String Name { get; } #

Friendly feature-pack name used for diagnostics and documentation.

public IReadOnlyList<MarkdownRendererPlugin> Plugins { get; } #

Reusable renderer plugins contributed by this feature pack.

public IReadOnlyList<IMarkdownDocumentTransform> ReaderDocumentTransforms { get; } #

Reader-side document transforms contributed by the composed plugins in this feature pack.

public IReadOnlyList<IMarkdownDocumentTransform> HtmlDocumentTransforms { get; } #

HTML-to-markdown document transforms contributed by the composed plugins in this feature pack.

public IReadOnlyList<IMarkdownDocumentTransform> RendererDocumentTransforms { get; } #

Renderer-side document transforms contributed by the composed plugins in this feature pack.

public IReadOnlyList<HtmlElementBlockConverter> HtmlElementBlockConverters { get; } #

HTML-to-markdown custom element block converters contributed by the composed plugins in this feature pack.

public IReadOnlyList<HtmlInlineElementConverter> HtmlInlineElementConverters { get; } #

HTML-to-markdown custom inline element converters contributed by the composed plugins in this feature pack.

public IReadOnlyList<MarkdownVisualElementRoundTripHint> VisualElementRoundTripHints { get; } #

Shared visual-host HTML round-trip hints contributed by the composed plugins in this feature pack.