Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MarkdownVisualContract

OfficeIMO.MarkdownRenderer

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

Shared HTML contract for renderer-produced visual blocks such as charts, networks, and dataviews. Hosts can use this API to emit or inspect the same metadata shape as the built-in renderer.

Inheritance

  • object
  • MarkdownVisualContract

Methods

AppendAttribute 2 overloads
public static void AppendAttribute(StringBuilder sb, string name, string? value) #

Appends an encoded string-valued HTML attribute.

Parameters

sb System.Text.StringBuilder required
name string required
value string? required
public static void AppendAttribute(StringBuilder sb, string name, int value) #

Appends an integer-valued HTML attribute using invariant culture formatting.

Parameters

sb System.Text.StringBuilder required
name string required
value int required
public static void AppendAttributes(StringBuilder sb, params KeyValuePair<string, string?>[] attributes) #

Appends multiple encoded string-valued HTML attributes.

Parameters

sb System.Text.StringBuilder required
attributes System.Collections.Generic.KeyValuePair<string, string?>[] required
public static void AppendCommonAttributes(StringBuilder sb, string visualKind, string language, MarkdownVisualPayload payload) #

Appends the shared visual metadata attributes to an existing HTML element builder.

Parameters

sb System.Text.StringBuilder required
visualKind string required
language string required
payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload required
public static void AppendFenceAttributes(StringBuilder sb, MarkdownCodeFenceInfo? fenceInfo, bool includeHtmlId = true) #

Appends shared fence metadata attributes such as the original normalized tail, element id, and classes to a visual host element builder.

Parameters

sb System.Text.StringBuilder required
fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo? required
includeHtmlId bool = true optional
BuildElementHtml 2 overloads
public static string BuildElementHtml(string elementName, string cssClass, string visualKind, string language, MarkdownVisualPayload payload, params KeyValuePair<string, string?>[] extraAttributes) #

Builds a visual host element with the shared data-omd-* metadata contract.

Parameters

elementName string required
cssClass string required
visualKind string required
language string required
payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload required
extraAttributes System.Collections.Generic.KeyValuePair<string, string?>[] required

Returns

string
public static string BuildElementHtml(string elementName, string cssClass, string visualKind, string language, MarkdownVisualPayload payload, MarkdownCodeFenceInfo? fenceInfo, params KeyValuePair<string, string?>[] extraAttributes) #

Builds a visual host element with the shared data-omd-* metadata contract and optional structured fence metadata such as #id and .class.

Parameters

elementName string required
cssClass string required
visualKind string required
language string required
payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload required
fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo? required
extraAttributes System.Collections.Generic.KeyValuePair<string, string?>[] required

Returns

string
public static string ComposeCssClass(string cssClass, MarkdownCodeFenceInfo? fenceInfo) #

Merges shared visual-host CSS classes with any fence-provided classes while keeping case-insensitive uniqueness.

Parameters

cssClass string required
fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo? required

Returns

string
public static string ComputePayloadHash(string? rawContent) #

Computes a stable cross-platform payload hash for renderer-owned visual content. JSON payloads are canonicalized before hashing so whitespace and object-property order do not affect the hash.

Parameters

rawContent string? required

Returns

string
public static MarkdownVisualPayload CreatePayload(string? rawContent) #

Creates a payload descriptor from raw JSON or other renderer-owned source text.

Parameters

rawContent string? required

Fields

public const string ContractVersion #

Current shared visual contract version.

Value: v1
public const string ConfigFormatJson #

Config format emitted by the built-in visual renderers.

Value: json
public const string ConfigEncodingBase64Utf8 #

Config encoding emitted by the built-in visual renderers.

Value: base64-utf8