# MarkdownVisualContract

Shared HTML contract for renderer-produced visual blocks such as charts, networks, and dataviews.

Class 

`OfficeIMO.MarkdownRenderer`

**Namespace**

`OfficeIMO.MarkdownRenderer`

**Assembly**

`OfficeIMO.MarkdownRenderer`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[MarkdownVisualContract.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L25)

**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

Filter members 

Show inherited

## Methods

AppendAttribute 2 overloads

`public static void AppendAttribute(StringBuilder sb, string name, string? value)` [#](#method-appendattribute-text-stringbuilder-string-string)

[MarkdownVisualContract.cs:120](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L120)

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)` [#](#method-appendattribute-text-stringbuilder-string-int32)

[MarkdownVisualContract.cs:137](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L137)

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)` [#](#method-appendattributes-text-stringbuilder-collections-generic-keyvaluepair-system-string-system-string)

[MarkdownVisualContract.cs:154](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L154)

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)` [#](#method-appendcommonattributes-text-stringbuilder-string-string-officeimo-markdownrenderer-markdownvisualpayload)

[MarkdownVisualContract.cs:103](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L103)

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)` [#](#method-appendfenceattributes-text-stringbuilder-officeimo-markdown-markdowncodefenceinfo-boolean)

[MarkdownVisualContract.cs:171](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L171)

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)` [#](#method-buildelementhtml-string-string-string-string-officeimo-markdownrenderer-markdownvisualpayload-collections-generic-keyvaluepair-system-string-system-string)

[MarkdownVisualContract.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L50)

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)` [#](#member-15cb74ff1827b67c9b351ef8)

[MarkdownVisualContract.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L72)

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)` [#](#method-composecssclass-string-officeimo-markdown-markdowncodefenceinfo)

[MarkdownVisualContract.cs:195](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L195)

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)` [#](#method-computepayloadhash-string)

[MarkdownVisualContract.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L37)

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)` [#](#method-createpayload-string)

[MarkdownVisualContract.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L25)

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

Parameters

**rawContent string? required**

Returns

`MarkdownVisualPayload`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Fields

`public const string ContractVersion` [#](#field-contractversion)

[MarkdownVisualContract.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L13)

Current shared visual contract version.

Value: `v1`

`public const string ConfigFormatJson` [#](#field-configformatjson)

[MarkdownVisualContract.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L16)

Config format emitted by the built-in visual renderers.

Value: `json`

`public const string ConfigEncodingBase64Utf8` [#](#field-configencodingbase64utf8)

[MarkdownVisualContract.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.MarkdownRenderer/MarkdownVisualContract.cs#L19)

Config encoding emitted by the built-in visual renderers.

Value: `base64-utf8`

<!-- PowerForge markdown artifact sha256:1FE499EC53C3617AC40436E967C836E4AE78A2E633B767B5E5B1D276D1F2361A -->
