API Reference
VisioShowcaseSummary
Machine-readable and Markdown summary of generated Visio showcase packages and preview artifacts.
Inheritance
- Object
- VisioShowcaseSummary
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method VisioShowcaseSummary.Create
Methods
public static VisioShowcaseSummary Create(String showcasePath, IEnumerable<String> packageFiles, IEnumerable<String> previewFiles = null, Nullable<DateTimeOffset> generatedAt = null, IEnumerable<String> proofFiles = null) #VisioShowcaseSummaryCreates a summary from generated package and preview paths.
Parameters
- showcasePath System.String
- Showcase root folder.
- packageFiles System.Collections.Generic.IEnumerable{System.String}
- Generated VSDX package paths.
- previewFiles System.Collections.Generic.IEnumerable{System.String} = null
- Generated preview paths.
- generatedAt System.Nullable{System.DateTimeOffset} = null
- Optional timestamp, primarily for deterministic tests.
- proofFiles System.Collections.Generic.IEnumerable{System.String} = null
- Generated structural proof paths, such as inspection and stencil-profile text artifacts.
public Void EnsureArtifactsValid(Boolean requirePreviewsPerDiagram = false, Boolean requireProofsPerDiagram = false) #VoidThrows when generated package or preview artifacts no longer match the summary metadata.
Parameters
- requirePreviewsPerDiagram System.Boolean = false
- Whether every generated package must have at least one matching preview artifact.
- requireProofsPerDiagram System.Boolean = false
- Whether every generated package must have at least one matching structural proof artifact.
public Void SaveArtifacts() #VoidWrites the default Markdown and JSON summary files into the showcase root.
public Void SaveHtml(String path) #VoidWrites a browsable HTML gallery to the specified path.
Parameters
- path System.String
- Target HTML file path.
public Void SaveJson(String path) #VoidWrites a machine-readable JSON summary to the specified path.
Parameters
- path System.String
- Target JSON file path.
public Void SaveMarkdown(String path) #VoidWrites a Markdown summary to the specified path.
Parameters
- path System.String
- Target Markdown file path.
public String ToHtml() #StringRenders a browsable HTML gallery for generated packages and preview artifacts.
public VisioShowcaseValidationReport ValidateArtifacts(Boolean requirePreviewsPerDiagram = false, Boolean requireProofsPerDiagram = false) #VisioShowcaseValidationReportValidates that showcase package and preview artifacts still match the summary metadata.
Parameters
- requirePreviewsPerDiagram System.Boolean = false
- Whether every generated package must have at least one matching preview artifact.
- requireProofsPerDiagram System.Boolean = false
- Whether every generated package must have at least one matching structural proof artifact.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
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.