MarkdownVisualContract
OfficeIMO.MarkdownRenderer
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
public static void AppendAttribute(StringBuilder sb, string name, string? value) #Appends an encoded string-valued HTML attribute.
Parameters
- sb System.Text.StringBuilder
- name string
- value string?
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
- name string
- value int
public static void AppendAttributes(StringBuilder sb, params KeyValuePair<string, string?>[] attributes) #Appends multiple encoded string-valued HTML attributes.
Parameters
- sb System.Text.StringBuilder
- attributes System.Collections.Generic.KeyValuePair<string, string?>[]
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
- visualKind string
- language string
- payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload
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
- fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo?
- includeHtmlId bool = true
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
- cssClass string
- visualKind string
- language string
- payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload
- extraAttributes System.Collections.Generic.KeyValuePair<string, string?>[]
Returns
stringpublic 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
- cssClass string
- visualKind string
- language string
- payload OfficeIMO.MarkdownRenderer.MarkdownVisualPayload
- fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo?
- extraAttributes System.Collections.Generic.KeyValuePair<string, string?>[]
Returns
stringpublic 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
- fenceInfo OfficeIMO.Markdown.MarkdownCodeFenceInfo?
Returns
stringpublic 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?
Returns
stringpublic static MarkdownVisualPayload CreatePayload(string? rawContent) #Creates a payload descriptor from raw JSON or other renderer-owned source text.
Parameters
- rawContent string?
Returns
MarkdownVisualPayloadInherited Methods
Fields
public const string ConfigFormatJson #Config format emitted by the built-in visual renderers.
jsonpublic const string ConfigEncodingBase64Utf8 #Config encoding emitted by the built-in visual renderers.
base64-utf8