Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

MarkdownVisualContract

Namespace OfficeIMO.MarkdownRenderer
Assembly OfficeIMO.MarkdownRenderer
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) #
Returns: Void

Appends an encoded string-valued HTML attribute.

Parameters

sb System.Text.StringBuilder requiredposition: 0
name System.String requiredposition: 1
value System.String requiredposition: 2
public static Void AppendAttribute(StringBuilder sb, String name, Int32 value) #
Returns: Void

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

Parameters

sb System.Text.StringBuilder requiredposition: 0
name System.String requiredposition: 1
value System.Int32 requiredposition: 2
public static Void AppendAttributes(StringBuilder sb, params KeyValuePair<String, String>[] attributes) #
Returns: Void

Appends multiple encoded string-valued HTML attributes.

Parameters

sb System.Text.StringBuilder requiredposition: 0
attributes System.Collections.Generic.KeyValuePair{System.String,System.String}[] requiredposition: 1
public static Void AppendCommonAttributes(StringBuilder sb, String visualKind, String language, MarkdownVisualPayload payload) #
Returns: Void

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

Parameters

sb System.Text.StringBuilder requiredposition: 0
visualKind System.String requiredposition: 1
language System.String requiredposition: 2
payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload requiredposition: 3
public static Void AppendFenceAttributes(StringBuilder sb, MarkdownCodeFenceInfo fenceInfo, Boolean includeHtmlId = true) #
Returns: Void

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 requiredposition: 0
fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo requiredposition: 1
includeHtmlId System.Boolean = true optionalposition: 2
BuildElementHtml 2 overloads
public static String BuildElementHtml(String elementName, String cssClass, String visualKind, String language, MarkdownVisualPayload payload, params KeyValuePair<String, String>[] extraAttributes) #
Returns: String

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

Parameters

elementName System.String requiredposition: 0
cssClass System.String requiredposition: 1
visualKind System.String requiredposition: 2
language System.String requiredposition: 3
payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload requiredposition: 4
extraAttributes System.Collections.Generic.KeyValuePair{System.String,System.String}[] requiredposition: 5
public static String BuildElementHtml(String elementName, String cssClass, String visualKind, String language, MarkdownVisualPayload payload, MarkdownCodeFenceInfo fenceInfo, params KeyValuePair<String, String>[] extraAttributes) #
Returns: String

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

Parameters

elementName System.String requiredposition: 0
cssClass System.String requiredposition: 1
visualKind System.String requiredposition: 2
language System.String requiredposition: 3
payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload requiredposition: 4
fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo requiredposition: 5
extraAttributes System.Collections.Generic.KeyValuePair{System.String,System.String}[] requiredposition: 6
public static String ComposeCssClass(String cssClass, MarkdownCodeFenceInfo fenceInfo) #
Returns: String

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

Parameters

cssClass System.String requiredposition: 0
fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo requiredposition: 1
public static String ComputePayloadHash(String rawContent) #
Returns: String

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 System.String requiredposition: 0
public static MarkdownVisualPayload CreatePayload(String rawContent) #
Returns: MarkdownVisualPayload

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

Parameters

rawContent System.String requiredposition: 0

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