VisioShowcaseSummary
OfficeIMO.Visio
Machine-readable and Markdown summary of generated Visio showcase packages and preview artifacts.
Inheritance
- object
- VisioShowcaseSummary
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Method VisioShowcaseSummary.Create
Methods
public static VisioShowcaseSummary Create(string showcasePath, IEnumerable<string> packageFiles, IEnumerable<string>? previewFiles = null, DateTimeOffset? generatedAt = null, IEnumerable<string>? proofFiles = null) #Creates a summary from generated package and preview paths.
Parameters
- showcasePath string
- Showcase root folder.
- packageFiles System.Collections.Generic.IEnumerable<string>
- Generated VSDX package paths.
- previewFiles System.Collections.Generic.IEnumerable<string>? = null
- Generated preview paths.
- generatedAt System.DateTimeOffset? = null
- Optional timestamp, primarily for deterministic tests.
- proofFiles System.Collections.Generic.IEnumerable<string>? = null
- Generated structural proof paths, such as inspection and stencil-profile text artifacts.
Returns
VisioShowcaseSummarypublic void EnsureArtifactsValid(bool requirePreviewsPerDiagram = false, bool requireProofsPerDiagram = false) #Throws when generated package or preview artifacts no longer match the summary metadata.
Parameters
- requirePreviewsPerDiagram bool = false
- Whether every generated package must have at least one matching preview artifact.
- requireProofsPerDiagram bool = false
- Whether every generated package must have at least one matching structural proof artifact.
public void SaveArtifacts() #Writes the default Markdown and JSON summary files into the showcase root.
public void SaveHtml(string path) #Writes a browsable HTML gallery to the specified path.
Parameters
- path string
- Target HTML file path.
public void SaveJson(string path) #Writes a machine-readable JSON summary to the specified path.
Parameters
- path string
- Target JSON file path.
public void SaveMarkdown(string path) #Writes a Markdown summary to the specified path.
Parameters
- path string
- Target Markdown file path.
public string ToHtml() #Renders a browsable HTML gallery for generated packages and preview artifacts.
Returns
stringpublic VisioShowcaseValidationReport ValidateArtifacts(bool requirePreviewsPerDiagram = false, bool requireProofsPerDiagram = false) #Validates that showcase package and preview artifacts still match the summary metadata.
Parameters
- requirePreviewsPerDiagram bool = false
- Whether every generated package must have at least one matching preview artifact.
- requireProofsPerDiagram bool = false
- Whether every generated package must have at least one matching structural proof artifact.
Inherited Methods
Properties
public string ShowcasePath { get; } #Absolute showcase root path used to calculate relative artifact paths.
public DateTimeOffset GeneratedAt { get; } #UTC timestamp recorded when the summary was created.
public IReadOnlyList<VisioShowcaseArtifact> Packages { get; } #Generated VSDX package artifacts.
public IReadOnlyList<VisioShowcaseArtifact> Previews { get; } #Generated preview artifacts.
public IReadOnlyList<VisioShowcaseArtifact> Proofs { get; } #Generated structural proof artifacts, such as inspection and stencil-profile text files.
public IReadOnlyList<VisioShowcaseArtifact> Artifacts { get; } #All package, preview, and structural proof artifacts in deterministic output order.
public IReadOnlyList<VisioShowcaseDiagram> Diagrams { get; } #Generated diagrams grouped with their package and matching preview artifacts.
public VisioShowcaseProofTotals ProofTotals { get; } #Structural proof metrics aggregated across all generated diagrams.
public VisioShowcaseEvidenceTotals EvidenceTotals { get; } #Preview and structural proof evidence completeness aggregated across all generated diagrams.
public IReadOnlyList<string> StencilCatalogs { get; } #Distinct stencil catalogs represented across all generated diagram proof summaries.
public IReadOnlyList<VisioShowcaseStencilCatalogCoverage> StencilCatalogCoverage { get; } #Stencil catalog coverage grouped by generated showcase diagrams.
Fields
public const string JsonFileName #Default machine-readable JSON summary file name.
showcase-summary.jsonpublic const string HtmlFileName #Default browsable HTML gallery file name.
showcase-gallery.html