Skip to content

docs: VisioAutomation.Models is undocumented (DOM + Layouts) #132

Description

@saveenr

Background

VisioAutomation.Models is entirely undocumented in the .NET-side gitbook (https://saveenr.gitbook.io/visioautomation/). It contains two major sub-systems that distinguish the library from raw COM interop:

DOM (VisioAutomation_2010/VisioAutomation.Models/Dom/): a declarative document-object model. Document -> PageList -> Page -> ShapeList -> Shape / Connector / Line / Rectangle / Oval / PolyLine / BezierCurve. Each node has a Render() that emits Visio operations. Lets callers build entire Visio diagrams declaratively and render them in a single batch.

Layouts (VisioAutomation_2010/VisioAutomation.Models/Layouts/): pre-built automated layouts. DirectedGraph, Tree, Grid, Container, Box, with renderers (MsaglRenderer, VisioLayoutRenderer) that map graph layouts to a Visio page. Plus LayoutStyles/ (Flowchart / Hierarchy / Radial / Compact-tree / Circular / Organizational-chart) and turn-key Documents/OrgCharts/ and Documents/Forms/ generators.

Library users currently have to read the source to discover any of this. A user wanting to render a tree diagram or directed graph has no documentation at all.

Proposed work

Tier 3 of the doc audit per docs/FUTURES.md. Roughly six to eight pages:

  • DOM document model overview (Document / Page / ShapeList / Shape / Connector / Line / Oval / BezierCurve / PolyLine / Hyperlink, the Node / NodeList containment pattern).
  • Layouts: LayoutStyleBase and its subclasses.
  • OrgChart: OrgChartDocument, OrgChartStyling, OrgChartLayoutOptions. The .NET counterpart of the existing PS-side Out-VisioApplication -OrgChart flow.
  • DirectedGraph: DirectedGraphDocument and node / edge types.
  • DataTable: DataTableModel for tabular layouts.
  • XmlModel: generic XML-backed renderer.
  • Forms: FormDocument, FormPage, InteractiveRenderer, TextBlock.

Source-side starter: VisioAutomation_2010/VisioAutomation.Models/README.md.

Effort

M (~6-8 pages, same shape as the Tier 1 / 2 / 4 audit work that landed in 2026-05).

See also

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions