API Reference

Class

HtmlCapabilityGalleryArtifact

Namespace OfficeIMO.Html
Assembly OfficeIMO.Html
Modifiers sealed

Describes one artifact emitted by an HTML capability-gallery scenario.

Inheritance

  • Object
  • HtmlCapabilityGalleryArtifact

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

public HtmlCapabilityGalleryArtifact(String id, String kind, String path, String mediaType, Int64 length, String sha256) #

Creates an artifact descriptor.

Parameters

id System.String requiredposition: 0
Stable artifact identifier within the scenario.
kind System.String requiredposition: 1
Artifact kind, such as input-html, docx, or roundtrip-html.
path System.String requiredposition: 2
Artifact file path.
mediaType System.String requiredposition: 3
Artifact media type.
length System.Int64 requiredposition: 4
Artifact length in bytes.
sha256 System.String requiredposition: 5
Lowercase hexadecimal SHA-256 hash of the artifact bytes.

Methods

public static HtmlCapabilityGalleryArtifact FromFile(String id, String kind, String path, String mediaType) #
Returns: HtmlCapabilityGalleryArtifact

Creates an artifact descriptor from an existing file.

Parameters

id System.String requiredposition: 0
Stable artifact identifier within the scenario.
kind System.String requiredposition: 1
Artifact kind, such as input-html, docx, or roundtrip-html.
path System.String requiredposition: 2
Artifact file path.
mediaType System.String requiredposition: 3
Artifact media type.

Returns

A descriptor containing file length and SHA-256 hash.

public static HtmlCapabilityGalleryArtifact WriteTextFile(String id, String kind, String path, String mediaType, String content) #
Returns: HtmlCapabilityGalleryArtifact

Writes text content to an artifact file and returns its descriptor.

Parameters

id System.String requiredposition: 0
Stable artifact identifier within the scenario.
kind System.String requiredposition: 1
Artifact kind, such as semantic-html or manifest-json.
path System.String requiredposition: 2
Artifact file path.
mediaType System.String requiredposition: 3
Artifact media type.
content System.String requiredposition: 4
Text content to write.

Returns

A descriptor containing file length and SHA-256 hash.

Properties

public String Id { get; } #

Stable artifact identifier within the scenario.

public String Kind { get; } #

Artifact kind, such as input-html, docx, or roundtrip-html.

public String Path { get; } #

Artifact file path.

public String MediaType { get; } #

Artifact media type.

public Int64 Length { get; } #

Artifact length in bytes.

public String Sha256 { get; } #

Lowercase hexadecimal SHA-256 hash of the artifact bytes.