Class

VisioDocument

OfficeIMO.Visio

Edit on GitHub

Namespace: OfficeIMO.Visio
Assembly: OfficeIMO.Visio
Source revision: 0eef6a5756b9 with working tree changes
Source: VisioDocument.cs:77
Implements: IDisposable

Represents a Visio document containing pages.

Inheritance

object
VisioDocument

Usage

Explore 112 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 45

Method VisioArchitectureDiagramDocumentExtensions.ArchitectureDiagram
Method VisioBlockDiagramDocumentExtensions.BlockDiagram
Method VisioDependencyDiagramDocumentExtensions.DependencyDiagram
Method VisioFlowchartDocumentExtensions.Flowchart
Method VisioGraphDiagramDocumentExtensions.GraphDiagram
Method VisioNetworkDiagramDocumentExtensions.NetworkDiagram
Method VisioNetworkDiagramDocumentExtensions.NetworkTopologyDiagram
Method VisioOrgChartDiagramDocumentExtensions.OrgChartDiagram
Method VisioSequenceDiagramDocumentExtensions.SequenceDiagram
Method VisioSwimlaneDiagramDocumentExtensions.SwimlaneDiagram
Method VisioTimelineDiagramDocumentExtensions.TimelineDiagram
Method VisioStencilGalleryDocument.AddStencilGalleryDocument
Method VisioStencilGalleryDocument.Create
Method VisioDiagramPolishExtensions.PolishDiagrams
Method VisioDiagramQualityAnalyzer.EnsureVisualQuality
Extension method VisioDocument.AddStencilGalleryDocument
Extension method VisioDocument.ArchitectureDiagram
Extension method VisioDocument.BlockDiagram
Extension method VisioDocument.DependencyDiagram
Extension method VisioDocument.EnsureVisualQuality
Extension method VisioDocument.Flowchart
Extension method VisioDocument.GraphDiagram
Extension method VisioDocument.NetworkDiagram
Extension method VisioDocument.NetworkTopologyDiagram
Extension method VisioDocument.OrgChartDiagram
Extension method VisioDocument.PolishDiagrams
Extension method VisioDocument.SequenceDiagram
Extension method VisioDocument.SwimlaneDiagram
Extension method VisioDocument.TimelineDiagram
Method VisioDocument.ConfigureProperties
Method VisioDocument.Create
Method VisioDocument.Load
Method VisioDocument.LoadAsync
Method VisioDocument.LoadLegacyBinary
Method VisioDocument.LoadLegacyXml
Method VisioGallery.CreateApplicationDependencyGraph
Method VisioGallery.CreateCiCdInventoryGraph
Method VisioGallery.CreateDataPlatformLineageGraph
Method VisioGallery.CreateHybridNetworkOperationsGraph
Method VisioGallery.CreateIdentityAuthenticationGraph
Method VisioGallery.CreateIncidentRunbookSequence
Method VisioGallery.CreateKubernetesServiceMeshGraph
Method VisioGallery.CreateNetworkSegmentationDiagram
Method VisioGallery.CreatePrivilegedAccessReviewGraph
Method VisioGallery.CreateProcessGovernanceReviewGraph

Accepted by parameters 67

Method VisioArchitectureDiagramDocumentExtensions.ArchitectureDiagram parameter document
Method VisioBlockDiagramDocumentExtensions.BlockDiagram parameter document
Method VisioDependencyDiagramDocumentExtensions.DependencyDiagram parameter document
Method VisioFlowchartDocumentExtensions.Flowchart parameter document
Method VisioGraphDiagramDocumentExtensions.GraphDiagram parameter document
Method VisioNetworkDiagramDocumentExtensions.NetworkDiagram parameter document
Method VisioNetworkDiagramDocumentExtensions.NetworkTopologyDiagram parameter document
Method VisioOrgChartDiagramDocumentExtensions.OrgChartDiagram parameter document
Method VisioSequenceDiagramDocumentExtensions.SequenceDiagram parameter document
Method VisioSwimlaneDiagramDocumentExtensions.SwimlaneDiagram parameter document
Method VisioTimelineDiagramDocumentExtensions.TimelineDiagram parameter document
Method VisioStencilGalleryDocument.AddStencilGalleryDocument parameter document
Method VisioDiagramPolishExtensions.PolishDiagrams parameter document
Method VisioDiagramQualityAnalyzer.AnalyzeVisualQuality parameter document
Method VisioDiagramQualityAnalyzer.EnsureVisualQuality parameter document
Method VisioDiagramQualityAnalyzer.GetVisualQualityReport parameter document
Extension method VisioDocument.AddStencilGalleryDocument parameter document
Extension method VisioDocument.AnalyzeVisualQuality parameter document
Extension method VisioDocument.ApplyStencilMigration parameter document
Extension method VisioDocument.ArchitectureDiagram parameter document
Extension method VisioDocument.BlockDiagram parameter document
Extension method VisioDocument.CreateStencilProfile parameter document
Extension method VisioDocument.DependencyDiagram parameter document
Extension method VisioDocument.DuplicatePage parameter document
Extension method VisioDocument.EnsureVisualQuality parameter document
Extension method VisioDocument.Flowchart parameter document
Extension method VisioDocument.GetVisualQualityReport parameter document
Extension method VisioDocument.GraphDiagram parameter document
Extension method VisioDocument.Inspect parameter document
Extension method VisioDocument.NetworkDiagram parameter document
Extension method VisioDocument.NetworkTopologyDiagram parameter document
Extension method VisioDocument.OrgChartDiagram parameter document
Extension method VisioDocument.PlanStencilMigration parameter document
Extension method VisioDocument.PolishDiagrams parameter document
Extension method VisioDocument.SaveAsImage parameter document
Extension method VisioDocument.SaveAsImageAsync parameter document
Extension method VisioDocument.SaveAsImages parameter document
Extension method VisioDocument.SaveAsImagesAsync parameter document
Extension method VisioDocument.SequenceDiagram parameter document
Extension method VisioDocument.SwimlaneDiagram parameter document
Extension method VisioDocument.TimelineDiagram parameter document
Extension method VisioDocument.ToDrawings parameter document
Extension method VisioDocument.ToImage parameter document
Extension method VisioDocument.ToImageAsync parameter document
Extension method VisioDocument.ToImages parameter document
Extension method VisioDocument.ToImagesAsync parameter document
Extension method VisioDocument.ToOfficeDocumentModel parameter document
Extension method VisioDocument.ToSvg parameter document
Extension method VisioDocument.ToSvgAsync parameter document
Method VisioDocumentModelExtensions.ToOfficeDocumentModel parameter document
Method VisioDrawingExtensions.ToDrawings parameter document
Method VisioDuplicationExtensions.DuplicatePage parameter document
Method VisioImageExportExtensions.SaveAsImage parameter document
Method VisioImageExportExtensions.SaveAsImageAsync parameter document
Method VisioImageExportExtensions.SaveAsImages parameter document
Method VisioImageExportExtensions.SaveAsImagesAsync parameter document
Method VisioImageExportExtensions.ToImage parameter document
Method VisioImageExportExtensions.ToImageAsync parameter document
Method VisioImageExportExtensions.ToImages parameter document
Method VisioImageExportExtensions.ToImagesAsync parameter document
Method VisioInspectionExtensions.Inspect parameter document
Method VisioStencilMigrationExtensions.ApplyStencilMigration parameter document
Method VisioStencilMigrationPlanApplyExtensions.ApplyStencilMigration parameter document
Method VisioStencilMigrationPlanningExtensions.PlanStencilMigration parameter document
Method VisioStencilProfileExtensions.CreateStencilProfile parameter document
Method VisioSvgExportExtensions.ToSvg parameter document
Method VisioSvgExportExtensions.ToSvgAsync parameter document

Constructors

public VisioDocument() #

VisioDocument.cs:77

Methods

AddBackgroundPage 2 overloads

public VisioPage AddBackgroundPage(string name, Action<VisioPage> configure) #

VisioDocument.Authoring.cs:7

Adds a background page and configures the created native page.

Parameters

name string required
configure System.Action<OfficeIMO.Visio.VisioPage> required

Returns

VisioPage

public VisioPage AddBackgroundPage(string name, OfficeLength? width = null, OfficeLength? height = null, VisioMeasurementUnit scaleUnit = Inches, int? id = null, Action<VisioPage>? configure = null)

VisioDocument.Lengths.cs:15

Adds a page with physical dimensions and explicit native drawing-scale units.

Parameters

name string required
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
scaleUnit OfficeIMO.Visio.VisioMeasurementUnit = Inches optional
id int? = null optional
configure System.Action<OfficeIMO.Visio.VisioPage>? = null optional

Returns

VisioPage

AddPage 2 overloads

public VisioPage AddPage(string name, Action<VisioPage> configure) #

VisioDocument.Authoring.cs:5

Adds a default-sized page and configures the created native page.

Parameters

name string required
configure System.Action<OfficeIMO.Visio.VisioPage> required

Returns

VisioPage

public VisioPage AddPage(string name, OfficeLength? width = null, OfficeLength? height = null, VisioMeasurementUnit scaleUnit = Inches, int? id = null, Action<VisioPage>? configure = null)

VisioDocument.Lengths.cs:6

Adds a page with physical dimensions and explicit native drawing-scale units.

Parameters

name string required
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
scaleUnit OfficeIMO.Visio.VisioMeasurementUnit = Inches optional
id int? = null optional
configure System.Action<OfficeIMO.Visio.VisioPage>? = null optional

Returns

VisioPage

public VisioDocument ConfigureProperties(Action<VisioDocumentProperties> configure) #

VisioDocument.Authoring.cs:21

Configures the document's native metadata.

Parameters

configure System.Action<OfficeIMO.Visio.VisioDocumentProperties> required

Returns

VisioDocument

Create 6 overloads

public static VisioDocument Create() #

VisioDocument.cs:387

Creates a detached document that must be saved explicitly to a path or stream.

Returns

VisioDocument

public static VisioDocument Create(VisioPackageType packageType) #

VisioDocument.cs:391

Creates a detached document for the specified Visio package family.

Parameters

packageType OfficeIMO.Visio.VisioPackageType required

Returns

VisioDocument

public static VisioDocument Create(string path) #

VisioDocument.cs:398

Creates a new VisioDocument with the given save path.

Parameters

path string required: Path where the document will be saved.

Returns

VisioDocument

public static VisioDocument Create(string path, VisioPackageType packageType) #

VisioDocument.cs:407

Creates a new document with an explicit package family and save path.

Parameters

path string required
packageType OfficeIMO.Visio.VisioPackageType required

Returns

VisioDocument

public static VisioDocument Create(Stream stream) #

VisioDocument.cs:416

Creates a new VisioDocument that will be saved to the provided stream.

Parameters

stream System.IO.Stream required: Destination stream for the VSDX package.

Returns

VisioDocument

public static VisioDocument Create(Stream stream, VisioPackageType packageType) #

VisioDocument.cs:426

Creates a stream-backed document with an explicit package family.

Parameters

stream System.IO.Stream required
packageType OfficeIMO.Visio.VisioPackageType required

Returns

VisioDocument

public void Dispose() #

VisioDocument.Lifecycle.cs:6

Completes the document lifecycle without saving or closing caller-owned streams.

public VisioMaster GetMaster(string nameU) #

VisioDocument.cs:663

Gets a registered master by NameU.

Parameters

nameU string required

Returns

VisioMaster

GetOrAddPage 2 overloads

public VisioPage GetOrAddPage(string name, Action<VisioPage> configure, StringComparison comparison = OrdinalIgnoreCase) #

VisioDocument.Authoring.cs:19

Gets or adds a named page and configures its native model.

Parameters

name string required
configure System.Action<OfficeIMO.Visio.VisioPage> required
comparison System.StringComparison = OrdinalIgnoreCase optional

Returns

VisioPage

public VisioPage GetOrAddPage(string name, OfficeLength? width = null, OfficeLength? height = null, VisioMeasurementUnit scaleUnit = Inches, int? id = null, StringComparison comparison = OrdinalIgnoreCase)

VisioDocument.Pages.cs:21

Gets an existing named page or creates one with the supplied physical dimensions.

Parameters

name string required
width OfficeIMO.OfficeLength? = null optional
height OfficeIMO.OfficeLength? = null optional
scaleUnit OfficeIMO.Visio.VisioMeasurementUnit = Inches optional
id int? = null optional
comparison System.StringComparison = OrdinalIgnoreCase optional

Returns

VisioPage

GetPage 5 overloads

public VisioPage GetPage(int index, Action<VisioPage> configure) #

VisioDocument.Authoring.cs:9

Configures an existing page selected by index.

Parameters

index int required
configure System.Action<OfficeIMO.Visio.VisioPage> required

Returns

VisioPage

public VisioPage GetPage(string name, Action<VisioPage> configure, StringComparison comparison = OrdinalIgnoreCase) #

VisioDocument.Authoring.cs:11

Configures an existing page selected by name.

Parameters

name string required
configure System.Action<OfficeIMO.Visio.VisioPage> required
comparison System.StringComparison = OrdinalIgnoreCase optional

Returns

VisioPage

public VisioPage GetPage(VisioPage page, Action<VisioPage> configure) #

VisioDocument.Authoring.cs:14

Configures a page belonging to this document.

Parameters

page OfficeIMO.Visio.VisioPage required
configure System.Action<OfficeIMO.Visio.VisioPage> required

Returns

VisioPage

public VisioPage GetPage(int pageIndex) #

VisioDocument.Pages.cs:6

Gets an existing page by zero-based index.

Parameters

pageIndex int required

Returns

VisioPage

public VisioPage GetPage(string name, StringComparison comparison = OrdinalIgnoreCase) #

VisioDocument.Pages.cs:12

Gets an existing page by name without adding a page.

Parameters

name string required
comparison System.StringComparison = OrdinalIgnoreCase optional

Returns

VisioPage

public void ImportMasters(string vsdxPath, IEnumerable<string>? names = null) #

VisioDocument.cs:210

Imports master names from a VSDX file and registers only the library-supported generated equivalents so shapes can reference them by NameU. If names is null or empty, all discoverable supported masters are registered.

Parameters

vsdxPath string required
names System.Collections.Generic.IEnumerable<string>? = null optional

public IReadOnlyList<VisioMaster> ImportMastersAndGet(string vsdxPath, IEnumerable<string>? names = null) #

VisioDocument.cs:218

Imports master names from a VSDX file and returns the registered generated masters that are natively implemented by the library.

Parameters

vsdxPath string required
names System.Collections.Generic.IEnumerable<string>? = null optional

Returns

IReadOnlyList<VisioMaster>

ImportStencilMasters 2 overloads

public void ImportStencilMasters(string packagePath, IEnumerable<string>? names = null) #

VisioDocument.cs:229

Imports actual master definitions from a user-supplied Visio stencil, drawing, or template package. Unlike VisioDocument.LearnMastersFromVsdx, this preserves the package master XML so shapes can use real external stencil artwork. Use this only for stencil packs the caller is allowed to embed.

Parameters

packagePath string required: Path to a `.vssx`, `.vsdx`, or `.vstx` package.
names System.Collections.Generic.IEnumerable<string>? = null optional: Optional filters matching master NameU, display name, relationship id, numeric id, or normalized slug.

public void ImportStencilMasters(IEnumerable<VisioStencilShape> shapes) #

VisioDocument.cs:300

Imports the package-backed masters required by the provided stencil shapes. Shapes loaded from multiple `.vssx`, `.vstx`, or `.vsdx` packages are grouped by source package.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.Visio.Stencils.VisioStencilShape> required: Stencil shapes with VisioStencilShape.SourcePackagePath metadata.

ImportStencilMastersAndGet 2 overloads

public IReadOnlyList<VisioMaster> ImportStencilMastersAndGet(string packagePath, IEnumerable<string>? names = null) #

VisioDocument.cs:238

Imports actual master definitions from a user-supplied Visio stencil, drawing, or template package and returns the registered masters.

Parameters

packagePath string required: Path to a `.vssx`, `.vsdx`, or `.vstx` package.
names System.Collections.Generic.IEnumerable<string>? = null optional: Optional filters matching master NameU, display name, relationship id, numeric id, or normalized slug.

Returns

IReadOnlyList<VisioMaster>

public IReadOnlyList<VisioMaster> ImportStencilMastersAndGet(IEnumerable<VisioStencilShape> shapes) #

VisioDocument.cs:308

Imports the package-backed masters required by the provided stencil shapes and returns the imported masters.

Parameters

shapes System.Collections.Generic.IEnumerable<OfficeIMO.Visio.Stencils.VisioStencilShape> required: Stencil shapes with VisioStencilShape.SourcePackagePath metadata.

Returns

IReadOnlyList<VisioMaster>

public OfficeHiddenDataReport InspectHiddenData() #

VisioDocument.HiddenData.cs:16

Finds metadata, personal information and hidden data that saving this drawing would keep, without changing it. Saving writes a new package from the drawing model, so package properties other than title and author, thumbnails and package-level Content Credentials of a loaded file are not carried into the saved file and are not reported.

Returns

OfficeHiddenDataReport

InspectSignatures 2 overloads

public static OfficePackageSignatureInfo InspectSignatures(string filePath, OfficePackageSignatureInspectionOptions? options = null)

VisioDocument.PackageSignatures.cs:11

Inspects a saved VSDX package through the shared dependency-light OPC signature engine.

Parameters

filePath string required
options OfficeIMO.Security.OfficePackageSignatureInspectionOptions? = null optional

Returns

OfficePackageSignatureInfo

public VisioSignatureInfo InspectSignatures() #

VisioDocument.Signatures.cs:60

Inspects the signature carrier discovered when this document was loaded. This is structural inspection; it does not validate cryptographic trust.

Returns

VisioSignatureInfo

public static bool IsBuiltinMasterSupported(string? nameU) #

VisioDocument.cs:598

Returns whether the library can generate a built-in master with the provided universal name.

Parameters

nameU string? required

Returns

bool

public IReadOnlyList<VisioMaster> LearnMastersFromVsdx(string vsdxPath, IEnumerable<string>? names = null) #

VisioDocument.cs:188

Learns master names from a VSDX file and registers only the library-supported generated equivalents so shapes can reference them by NameU. This does not ingest, clone, or depend on the source VSDX as a runtime template.

Parameters

vsdxPath string required: Path to a Visio package that contains master metadata.
names System.Collections.Generic.IEnumerable<string>? = null optional: Optional filters matching master NameU, display name, relationship id, numeric id, or normalized slug.

Returns

IReadOnlyList<VisioMaster>

public static IReadOnlyList<MasterInfo> ListMastersIn(string vsdxPath) #

VisioDocument.cs:178

Lists masters available in a given VSDX file (helper that proxies VisioAssets.ListMasters).

Parameters

vsdxPath string required

Returns

IReadOnlyList<MasterInfo>

Load 4 overloads

public static VisioDocument Load(string filePath) #

VisioDocument.Load.cs:11

Loads an existing .vsdx file into a VisioDocument.

Parameters

filePath string required

Returns

VisioDocument

public static VisioDocument Load(string filePath, VisioLoadOptions? options) #

VisioDocument.Load.cs:15

Loads an existing .vsdx file with explicit input limits.

Parameters

filePath string required
options OfficeIMO.Visio.VisioLoadOptions? required

Returns

VisioDocument

public static VisioDocument Load(Stream stream) #

VisioDocument.Load.cs:33

Loads an existing .vsdx document from a stream.

Parameters

stream System.IO.Stream required

Returns

VisioDocument

public static VisioDocument Load(Stream stream, VisioLoadOptions? options) #

VisioDocument.Load.cs:37

Loads an existing .vsdx document from a stream with explicit input limits.

Parameters

stream System.IO.Stream required
options OfficeIMO.Visio.VisioLoadOptions? required

Returns

VisioDocument

LoadAsync 2 overloads

public static async Task<VisioDocument> LoadAsync(string filePath, VisioLoadOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously loads an existing .vsdx file with optional input limits.

Parameters

filePath string required
options OfficeIMO.Visio.VisioLoadOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<VisioDocument>

public static async Task<VisioDocument> LoadAsync(Stream stream, VisioLoadOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously loads an existing .vsdx document from a caller-owned stream with optional input limits.

Parameters

stream System.IO.Stream required
options OfficeIMO.Visio.VisioLoadOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<VisioDocument>

LoadLegacyBinary 2 overloads

public static OfficeConversionResult<VisioDocument, OfficeLegacyImportReport> LoadLegacyBinary(string path, VisioLegacyBinaryImportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.LegacyBinary.cs:10

Imports a bounded Visio 2003–2010 VSD drawing, VSS stencil or VST template with a loss report.

Parameters

path string required
options OfficeIMO.Visio.VisioLegacyBinaryImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionResult<VisioDocument, OfficeLegacyImportReport>

public static OfficeConversionResult<VisioDocument, OfficeLegacyImportReport> LoadLegacyBinary(Stream stream, VisioPackageType packageType = Drawing, VisioLegacyBinaryImportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.LegacyBinary.cs:25

Imports the binary profile from a caller-owned stream, returning the existing editable Visio model.

Parameters

stream System.IO.Stream required
packageType OfficeIMO.Visio.VisioPackageType = Drawing optional
options OfficeIMO.Visio.VisioLegacyBinaryImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionResult<VisioDocument, OfficeLegacyImportReport>

LoadLegacyXml 2 overloads

public static OfficeConversionResult<VisioDocument, VisioXmlConversionReport> LoadLegacyXml(string path, VisioLoadOptions? options = null)

VisioDocument.LegacyXml.cs:12

Imports a Visio 2002/2003 VDX drawing, VSX stencil, or VTX template into the editable model with a fidelity report.

Parameters

path string required
options OfficeIMO.Visio.VisioLoadOptions? = null optional

Returns

OfficeConversionResult<VisioDocument, VisioXmlConversionReport>

public static OfficeConversionResult<VisioDocument, VisioXmlConversionReport> LoadLegacyXml(Stream stream, VisioPackageType packageType = Drawing, VisioLoadOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.LegacyXml.cs:23

Imports legacy XML from a caller-owned stream. Specify the family because legacy XML has no reliable drawing/template discriminator.

Parameters

stream System.IO.Stream required
packageType OfficeIMO.Visio.VisioPackageType = Drawing optional
options OfficeIMO.Visio.VisioLoadOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionResult<VisioDocument, VisioXmlConversionReport>

public void OpenInApplication(string? filePath = null) #

VisioDocument.Save.cs:8

Opens the associated document in the operating system's registered application.

Parameters

filePath string? = null optional

RegisterMaster 2 overloads

public VisioMaster RegisterMaster(VisioMaster master) #

VisioDocument.cs:605

Registers a master on the document so it can be reused by name.

Parameters

master OfficeIMO.Visio.VisioMaster required

Returns

VisioMaster

public VisioMaster RegisterMaster(string nameU, VisioShape shape, string? id = null) #

VisioDocument.cs:634

Registers a master blueprint under a NameU and returns the registered master.

Parameters

nameU string required
shape OfficeIMO.Visio.VisioShape required
id string? = null optional

Returns

VisioMaster

public OfficeHiddenDataReport RemoveHiddenData(OfficeHiddenDataOptions? options = null) #

VisioDocument.HiddenData.cs:21

Removes the selected categories of metadata and hidden data, then reports what was found and what happened to each item. Save the drawing to keep the result.

Parameters

options OfficeIMO.OfficeHiddenDataOptions? = null optional: Categories to remove; defaults to OfficeHiddenDataKind.Default, which keeps hidden content and provenance.

Returns

OfficeHiddenDataReport

RemoveProvenance 2 overloads

public static OfficeProvenanceRemovalResult RemoveProvenance(string inputPath, string outputPath, OfficeProvenanceRemovalOptions? options = null)

VisioDocument.Provenance.cs:31

Removes selected provenance and atomically writes a VSDX package.

Parameters

inputPath string required
outputPath string required
options OfficeIMO.Provenance.OfficeProvenanceRemovalOptions? = null optional

Returns

OfficeProvenanceRemovalResult

public static OfficeProvenanceRemovalResult RemoveProvenance(byte[] packageBytes, string fileName = "drawing.vsdx", OfficeProvenanceRemovalOptions? options = null)

VisioDocument.Provenance.cs:38

Removes selected provenance from encoded VSDX package bytes.

Parameters

packageBytes byte[] required
fileName string = "drawing.vsdx" optional
options OfficeIMO.Provenance.OfficeProvenanceRemovalOptions? = null optional

Returns

OfficeProvenanceRemovalResult

public void RequestRecalcOnOpen() #

VisioDocument.cs:383

Requests Visio to relayout and reroute connectors when the document is opened.

Save 4 overloads

public void Save() #

VisioDocument.Save.cs:17

Saves the document to the path specified when created.

public void Save(string filePath) #

VisioDocument.Save.cs:30

Saves the document to a specified file path.

Parameters

filePath string required

public void Save(string filePath, VisioPackageType packageType) #

VisioDocument.Save.cs:42

Saves to a specified path using an explicit Visio package family.

Parameters

filePath string required
packageType OfficeIMO.Visio.VisioPackageType required

public void Save(Stream stream) #

VisioDocument.Save.cs:55

Saves the document once to a specified stream without changing the associated destination.

Parameters

stream System.IO.Stream required

SaveAsync 3 overloads

public Task SaveAsync(CancellationToken cancellationToken = default) #

VisioDocument.Save.cs:87

Asynchronously saves to the associated path or stream.

Parameters

cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

public async Task SaveAsync(string filePath, CancellationToken cancellationToken = default) #

Asynchronously saves to a file and associates it with subsequent saves.

Parameters

filePath string required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

public async Task SaveAsync(Stream stream, CancellationToken cancellationToken = default) #

Asynchronously saves once to a caller-owned writable stream without changing the associated destination.

Parameters

stream System.IO.Stream required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

public void SaveCopy(string filePath) #

VisioDocument.Save.cs:63

Saves an independent copy without changing the document's associated destination.

Parameters

filePath string required

public Task SaveCopyAsync(string filePath, CancellationToken cancellationToken = default) #

VisioDocument.Save.cs:70

Asynchronously saves an independent copy without changing the document's associated destination.

Parameters

filePath string required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

SaveLegacyXml 2 overloads

public VisioXmlConversionReport SaveLegacyXml(string path, bool allowOmissions = false) #

VisioDocument.LegacyXml.cs:66

Writes a legacy XML copy atomically. Omitted content requires explicit allowOmissions; inspect the returned report for approximations.

Parameters

path string required
allowOmissions bool = false optional

Returns

VisioXmlConversionReport

public VisioXmlConversionReport SaveLegacyXml(Stream stream, bool allowOmissions = false) #

VisioDocument.LegacyXml.cs:73

Writes legacy XML once to a caller-owned stream without changing the associated destination.

Parameters

stream System.IO.Stream required
allowOmissions bool = false optional

Returns

VisioXmlConversionReport

public static OfficePackageSigningResult SignPackage(string filePath, IOfficeSecurityProvider securityProvider, X509Certificate2 signingCertificate, OfficePackageSigningOptions? options = null)

VisioDocument.PackageSignatures.cs:26

Creates and validates an OPC signature in a saved VSDX package.

Parameters

filePath string required
securityProvider OfficeIMO.Security.IOfficeSecurityProvider required
signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required
options OfficeIMO.Security.OfficePackageSigningOptions? = null optional

Returns

OfficePackageSigningResult

public byte[] ToBytes() #

VisioDocument.Save.cs:78

Encodes the document using its current Visio package family.

Returns

byte[]

public OfficeConversionResult<byte[], VisioXmlConversionReport> ToLegacyXmlResult() #

VisioDocument.LegacyXml.cs:52

Encodes the current drawing, stencil or template as Visio 2003 XML with operation-level loss diagnostics.

Returns

OfficeConversionResult<byte[], VisioXmlConversionReport>

public MemoryStream ToStream() #

VisioDocument.Save.cs:83

Encodes the document in a new writable memory stream positioned at the beginning.

Returns

MemoryStream

public bool TryGetMaster(string nameU, out VisioMaster? master) #

VisioDocument.cs:645

Attempts to find a registered master by NameU.

Parameters

nameU string required
master OfficeIMO.Visio.VisioMaster? required

Returns

bool

public static OfficePackageSigningResult TrySignPackage(string filePath, IOfficeSecurityProvider securityProvider, X509Certificate2 signingCertificate, OfficePackageSigningOptions? options = null)

VisioDocument.PackageSignatures.cs:34

Attempts OPC signature creation without throwing for an ordinary signing failure.

Parameters

filePath string required
securityProvider OfficeIMO.Security.IOfficeSecurityProvider required
signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 required
options OfficeIMO.Security.OfficePackageSigningOptions? = null optional

Returns

OfficePackageSigningResult

public IReadOnlyList<string> Validate() #

VisioDocument.Validation.cs:10

Validates the in-memory document model and returns authoring-time issues.

Returns

IReadOnlyList<string>

public static OfficePackageSignatureValidationReport ValidateSignatures(string filePath, IOfficeSecurityProvider securityProvider, OfficePackageSignatureValidationOptions? options = null)

VisioDocument.PackageSignatures.cs:18

Validates a saved VSDX package through an explicitly supplied security provider.

Parameters

filePath string required
securityProvider OfficeIMO.Security.IOfficeSecurityProvider required
options OfficeIMO.Security.OfficePackageSignatureValidationOptions? = null optional

Returns

OfficePackageSignatureValidationReport

Inherited Methods

Properties

public string? FilePath { get; } #

VisioDocument.cs:105

Gets the file path associated with the document, if any.

public IReadOnlyList<VisioPage> Pages { get; } #

VisioDocument.cs:129

Gets the collection of pages in the document.

public VisioPackageType PackageType { get; } #

VisioDocument.cs:132

Gets the Open XML Visio package family loaded or selected for output.

public bool IsMacroEnabled { get; } #

VisioDocument.cs:135

Gets whether the package family can retain a VBA project.

public bool HasVbaProject { get; } #

VisioDocument.cs:138

Gets whether a preserved opaque VBA project is present.

public bool IsTemplate { get; } #

VisioDocument.cs:141

Gets whether this document is a template package.

public bool IsStencil { get; } #

VisioDocument.cs:144

Gets whether this document is a stencil package.

public IReadOnlyCollection<VisioMaster> Masters { get; } #

VisioDocument.cs:149

Gets the masters currently registered on the document.

public VisioPackageTheme? PackageTheme { get; set; } #

VisioDocument.cs:154

Gets or sets package-level theme metadata preserved in the document.

public VisioDocumentProperties Properties { get; } #

VisioDocument.cs:157

Standard package properties stored in docProps/core.xml.

public bool UseMastersByDefault { get; set; } #

VisioDocument.cs:165

When true, shapes with a known VisioShape.NameU (e.g. "Rectangle") are automatically backed by a document master if none is assigned explicitly. Defaults to false to preserve current library behavior. Set to true to align with native Visio authoring semantics and asset templates.

public bool WriteMasterDeltasOnly { get; set; } #

VisioDocument.cs:173

When writing page shapes that reference a master, emit only delta cells required for the page instance (e.g., PinX/PinY and minimal style hints) instead of a full XForm block. This better matches Visio-authored files and the provided assets. Defaults to true.

public static IReadOnlyCollection<string> SupportedBuiltinMasters { get; } #

VisioDocument.cs:592

Returns the built-in master names that this library can generate natively.

public VisioSignatureMutationPolicy SignatureMutationPolicy { get; set; } #

VisioDocument.Signatures.cs:53

Gets or sets the policy applied before a loaded signed VSDX package is rebuilt. The safe default blocks the save.

Extension Methods

public static VisioDocument AddStencilGalleryDocument(VisioDocument document, VisioStencilCatalog catalog, VisioStencilGalleryDocumentOptions? options = null)

VisioStencilGalleryDocument.cs:31

Adds stencil gallery review pages to an existing document.

Parameters

document OfficeIMO.Visio.VisioDocument required
catalog OfficeIMO.Visio.Stencils.VisioStencilCatalog required
options OfficeIMO.Visio.Stencils.VisioStencilGalleryDocumentOptions? = null optional

Returns

VisioDocument

public static IReadOnlyList<VisioDiagramQualityIssue> AnalyzeVisualQuality(VisioDocument document, VisioDiagramQualityOptions? options = null)

VisioDiagramQualityAnalyzer.cs:25

Analyzes every page in a document for common visual quality issues.

Parameters

document OfficeIMO.Visio.VisioDocument required: Document to analyze.
options OfficeIMO.Visio.VisioDiagramQualityOptions? = null optional: Analysis options.

Returns

IReadOnlyList<VisioDiagramQualityIssue>

ApplyStencilMigration 2 overloads

public static VisioStencilMigrationResult ApplyStencilMigration(VisioDocument document, VisioStencilMigrationMap map) #

VisioStencilMigrationExtensions.cs:10

Applies a stencil migration map to every foreground page in the document.

Parameters

document OfficeIMO.Visio.VisioDocument required
map OfficeIMO.Visio.VisioStencilMigrationMap required

Returns

VisioStencilMigrationResult

public static VisioStencilMigrationResult ApplyStencilMigration(VisioDocument document, VisioStencilMigrationPlan plan, VisioStencilMigrationMap map)

VisioStencilMigrationPlanApplyExtensions.cs:38

Applies a previously reviewed stencil migration plan to a document. The current document must still match the planned pages, shapes, match rules, and replacement stencils.

Parameters

document OfficeIMO.Visio.VisioDocument required: Document to update.
plan OfficeIMO.Visio.VisioStencilMigrationPlan required: Reviewed migration plan.
map OfficeIMO.Visio.VisioStencilMigrationMap required: Migration map used to create the plan.

Returns

VisioStencilMigrationResult

public static VisioDocument ArchitectureDiagram(VisioDocument document, string pageName, Action<VisioArchitectureDiagramBuilder> configure)

VisioArchitectureDiagramDocumentExtensions.cs:10

Adds a semantic architecture diagram page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioArchitectureDiagramBuilder> required

Returns

VisioDocument

public static VisioDocument BlockDiagram(VisioDocument document, string pageName, Action<VisioBlockDiagramBuilder> configure)

VisioBlockDiagramDocumentExtensions.cs:10

Adds a semantic block diagram page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioBlockDiagramBuilder> required

Returns

VisioDocument

public static VisioStencilProfile CreateStencilProfile(VisioDocument document) #

VisioStencilProfile.cs:14

Creates a deterministic stencil usage profile for the document.

Parameters

document OfficeIMO.Visio.VisioDocument required

Returns

VisioStencilProfile

public static VisioDocument DependencyDiagram(VisioDocument document, string pageName, Action<VisioDependencyDiagramBuilder> configure)

VisioDependencyDiagramDocumentExtensions.cs:10

Adds an automatically layered dependency diagram page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioDependencyDiagramBuilder> required

Returns

VisioDocument

DuplicatePage 2 overloads

public static VisioPage DuplicatePage(VisioDocument document, VisioPage sourcePage, string? name = null) #

VisioDuplicationExtensions.cs:20

Duplicates a page in the same document, preserving page settings, layers, shapes, and internal connectors.

Parameters

document OfficeIMO.Visio.VisioDocument required: Document that owns the source page and receives the duplicate.
sourcePage OfficeIMO.Visio.VisioPage required: Page to duplicate.
name string? = null optional: Optional name for the duplicate. When omitted, a unique copy name is generated.

Returns

VisioPage The duplicated page.

public static VisioPage DuplicatePage(VisioDocument document, VisioPage sourcePage, VisioPageDuplicationOptions? options)

VisioDuplicationExtensions.cs:31

Duplicates a page in the same document, preserving page settings, layers, shapes, and internal connectors.

Parameters

document OfficeIMO.Visio.VisioDocument required: Document that owns the source page and receives the duplicate.
sourcePage OfficeIMO.Visio.VisioPage required: Page to duplicate.
options OfficeIMO.Visio.VisioPageDuplicationOptions? required: Optional duplication settings.

Returns

VisioPage The duplicated page.

public static VisioDocument EnsureVisualQuality(VisioDocument document, VisioDiagramQualityOptions? options = null, VisioDiagramQualityIssueSeverity minimumSeverity = Warning)

VisioDiagramQualityAnalyzer.cs:50

Throws when a document contains visual quality issues at or above the requested severity.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioDiagramQualityOptions? = null optional
minimumSeverity OfficeIMO.Visio.VisioDiagramQualityIssueSeverity = Warning optional

Returns

VisioDocument

public static VisioDocument Flowchart(VisioDocument document, string pageName, Action<VisioFlowchartBuilder> configure) #

VisioFlowchartDocumentExtensions.cs:10

Adds a semantic flowchart page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioFlowchartBuilder> required

Returns

VisioDocument

public static VisioDiagramQualityReport GetVisualQualityReport(VisioDocument document, VisioDiagramQualityOptions? options = null)

VisioDiagramQualityAnalyzer.cs:40

Creates a visual quality report for every page in a document.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioDiagramQualityOptions? = null optional

Returns

VisioDiagramQualityReport

public static VisioDocument GraphDiagram(VisioDocument document, string pageName, Action<VisioGraphDiagramBuilder> configure)

VisioGraphDiagramDocumentExtensions.cs:10

Adds an automatically laid out generic graph page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioGraphDiagramBuilder> required

Returns

VisioDocument

public static VisioInspectionSnapshot Inspect(VisioDocument document) #

VisioInspectionExtensions.cs:16

Creates a stable, data-oriented snapshot of the document structure.

Parameters

document OfficeIMO.Visio.VisioDocument required

Returns

VisioInspectionSnapshot

public static VisioDocument NetworkDiagram(VisioDocument document, string pageName, Action<VisioNetworkDiagramBuilder> configure)

VisioNetworkDiagramDocumentExtensions.cs:10

Adds a semantic network diagram page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioNetworkDiagramBuilder> required

Returns

VisioDocument

public static VisioDocument NetworkTopologyDiagram(VisioDocument document, string pageName, Action<VisioNetworkTopologyDiagramBuilder> configure)

VisioNetworkDiagramDocumentExtensions.cs:21

Adds a semantic network topology page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioNetworkTopologyDiagramBuilder> required

Returns

VisioDocument

public static VisioDocument OrgChartDiagram(VisioDocument document, string pageName, Action<VisioOrgChartDiagramBuilder> configure)

VisioOrgChartDiagramDocumentExtensions.cs:10

Adds a semantic org chart page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioOrgChartDiagramBuilder> required

Returns

VisioDocument

public static VisioStencilMigrationPlan PlanStencilMigration(VisioDocument document, VisioStencilMigrationMap map) #

VisioStencilMigrationPlanningExtensions.cs:10

Plans a stencil migration map for every foreground page in the document without modifying the document.

Parameters

document OfficeIMO.Visio.VisioDocument required
map OfficeIMO.Visio.VisioStencilMigrationMap required

Returns

VisioStencilMigrationPlan

public static VisioDocument PolishDiagrams(VisioDocument document, VisioDiagramPolishOptions? options = null) #

VisioDiagramPolishExtensions.cs:12

Applies a deterministic cleanup pass to every foreground page in the document.

Parameters

document OfficeIMO.Visio.VisioDocument required: Document whose pages should be polished.
options OfficeIMO.Visio.VisioDiagramPolishOptions? = null optional: Optional polish settings.

Returns

VisioDocument

SaveAsImage 2 overloads

public static OfficeConversionReport SaveAsImage(VisioDocument document, string path, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageConversion.cs:36

Writes the selected page to a file and returns its fidelity report.

Parameters

document OfficeIMO.Visio.VisioDocument required
path string required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

public static OfficeConversionReport SaveAsImage(VisioDocument document, Stream stream, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageConversion.cs:46

Writes the selected page to a caller-owned stream and returns its fidelity report.

Parameters

document OfficeIMO.Visio.VisioDocument required
stream System.IO.Stream required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

SaveAsImageAsync 2 overloads

public static async Task<OfficeConversionReport> SaveAsImageAsync(VisioDocument document, string path, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously writes the selected page to a file and returns its fidelity report.

Parameters

document OfficeIMO.Visio.VisioDocument required
path string required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public static async Task<OfficeConversionReport> SaveAsImageAsync(VisioDocument document, Stream stream, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously writes the selected page to a caller-owned stream and returns its fidelity report.

Parameters

document OfficeIMO.Visio.VisioDocument required
stream System.IO.Stream required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public static OfficeConversionReport SaveAsImages(VisioDocument document, string folderPath, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageBatchConversion.cs:24

Saves selected images without retaining payloads and returns aggregate conversion evidence.

Parameters

document OfficeIMO.Visio.VisioDocument required
folderPath string required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport

public static async Task<OfficeConversionReport> SaveAsImagesAsync(VisioDocument document, string folderPath, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

Asynchronously saves selected images, retaining paths and evidence rather than encoded payloads.

Parameters

document OfficeIMO.Visio.VisioDocument required
folderPath string required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>

public static VisioDocument SequenceDiagram(VisioDocument document, string pageName, Action<VisioSequenceDiagramBuilder> configure)

VisioSequenceDiagramDocumentExtensions.cs:10

Adds a semantic sequence diagram page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioSequenceDiagramBuilder> required

Returns

VisioDocument

public static VisioDocument SwimlaneDiagram(VisioDocument document, string pageName, Action<VisioSwimlaneDiagramBuilder> configure)

VisioSwimlaneDiagramDocumentExtensions.cs:10

Adds a semantic swimlane diagram page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioSwimlaneDiagramBuilder> required

Returns

VisioDocument

public static VisioDocument TimelineDiagram(VisioDocument document, string pageName, Action<VisioTimelineDiagramBuilder> configure)

VisioTimelineDiagramDocumentExtensions.cs:10

Adds a semantic timeline page and returns the document for chaining.

Parameters

document OfficeIMO.Visio.VisioDocument required
pageName string required
configure System.Action<OfficeIMO.Visio.Diagrams.VisioTimelineDiagramBuilder> required

Returns

VisioDocument

public static OfficeConversionResult<IReadOnlyList<OfficeDrawing>, VisioDrawingConversionReport> ToDrawings(VisioDocument document, VisioDrawingOptions? options = null, CancellationToken cancellationToken = default)

VisioDrawingExtensions.cs:11

Projects every source page in document order, including blank and background pages.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioDrawingOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionResult<IReadOnlyList<OfficeDrawing>, VisioDrawingConversionReport>

ToImage 3 overloads

public static OfficeImageExportResult ToImage(VisioDocument document, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageConversion.cs:9

Renders the selected page using the encoding in OfficeImageExportOptions.Format.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult

public static OfficeImageExportResult ToImage(VisioDocument document, VisioImageExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)

VisioDocument.ImageConversion.cs:14

Renders the selected page and returns its immutable fidelity report.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult

public static OfficeImageExportResult ToImage(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioImageExportExtensions.cs:21

Exports the selected document page to a supported raster format or SVG.

Parameters

document OfficeIMO.Visio.VisioDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeImageExportResult

public static async Task<OfficeImageExportResult> ToImageAsync(VisioDocument document, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

Renders the selected page with cancellation and returns the encoded image and its diagnostics.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeImageExportResult>

ToImages 3 overloads

public static IReadOnlyList<OfficeImageExportResult> ToImages(VisioDocument document, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageBatchConversion.cs:10

Renders a batch using the encoding and selection in the options.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>

public static IReadOnlyList<OfficeImageExportResult> ToImages(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions? options = null)

VisioImageExportExtensions.cs:43

Exports a selected range of document pages to a supported raster format or SVG.

Parameters

document OfficeIMO.Visio.VisioDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional

Returns

IReadOnlyList<OfficeImageExportResult>

public static void ToImages(VisioDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioImageExportExtensions.cs:55

Streams selected document page images without retaining earlier payloads.

Parameters

document OfficeIMO.Visio.VisioDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

ToImagesAsync 3 overloads

public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(VisioDocument document, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageBatchConversion.cs:17

Renders a batch asynchronously using the same options and evidence contract.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>

public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageBatchConversion.cs:47

Asynchronously exports selected images through the shared bounded streaming bridge.

Parameters

document OfficeIMO.Visio.VisioDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeImageExportResult>>

public static Task ToImagesAsync(VisioDocument document, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, VisioImageExportOptions? options = null, CancellationToken cancellationToken = default)

VisioDocument.ImageBatchConversion.cs:55

Asynchronously delivers selected images with backpressure and cooperative cancellation.

Parameters

document OfficeIMO.Visio.VisioDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer required
options OfficeIMO.Visio.VisioImageExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

public static OfficeDocumentModel ToOfficeDocumentModel(VisioDocument document, string? sourceName = null, VisioDocumentProjectionOptions? options = null, CancellationToken cancellationToken = default)

VisioDocumentModelExtensions.cs:17

Projects an already loaded Visio document into the neutral document model.

Parameters

document OfficeIMO.Visio.VisioDocument required
sourceName string? = null optional
options OfficeIMO.Visio.VisioDocumentProjectionOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeDocumentModel

ToSvg 2 overloads

public static string ToSvg(VisioDocument document, VisioSvgSaveOptions? options = null, CancellationToken cancellationToken = default)

VisioSvgExportExtensions.cs:11

Renders the selected page as decoded SVG text.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioSvgSaveOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string

public static string ToSvg(VisioDocument document, VisioSvgSaveOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)

VisioSvgExportExtensions.cs:16

Renders SVG text while retaining structured image fidelity diagnostics.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioSvgSaveOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string

public static Task<OfficeConversionResult<string>> ToSvgAsync(VisioDocument document, VisioSvgSaveOptions? options = null, CancellationToken cancellationToken = default)

VisioSvgExportExtensions.cs:25

Renders SVG text asynchronously and returns the completed report.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioSvgSaveOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>

Inheritance

Guides & Samples

Usage

Returned or exposed by 45

Accepted by parameters 67

Constructors

Methods

Inherited Methods

Properties

Extension Methods