API Reference
VisioDocument
Represents a Visio document containing pages.
Inheritance
- Object
- VisioDocument
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 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 VisioFluentDocument.End
- Method VisioStencilGalleryDocument.AddStencilGalleryDocument
- Method VisioStencilGalleryDocument.Create
- 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.Create
- Method VisioDocument.Create
- Method VisioDocument.Create
- Method VisioDocument.Create
- Method VisioDocument.Create
- Method VisioDocument.Create
- Method VisioDocument.Load
- Method VisioDocument.Load
- Method VisioDocument.Load
- Method VisioDocument.Load
- Method VisioDocument.LoadAsync
- Method VisioDocument.LoadAsync
- 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
- 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
- Constructor VisioFluentDocument.VisioFluentDocument
- Method VisioFluentDocumentExtensions.AsFluent
- Method VisioStencilGalleryDocument.AddStencilGalleryDocument
- Method VisioDiagramPolishExtensions.PolishDiagrams
- Method VisioDiagramQualityAnalyzer.AnalyzeVisualQuality
- Method VisioDiagramQualityAnalyzer.EnsureVisualQuality
- Method VisioDiagramQualityAnalyzer.GetVisualQualityReport
- Extension method VisioDocument.AddStencilGalleryDocument
- Extension method VisioDocument.AnalyzeVisualQuality
- Extension method VisioDocument.ApplyStencilMigration
- Extension method VisioDocument.ApplyStencilMigration
- Extension method VisioDocument.ArchitectureDiagram
- Extension method VisioDocument.AsFluent
- Extension method VisioDocument.BlockDiagram
- Extension method VisioDocument.CreateInspectionSnapshot
- Extension method VisioDocument.CreateStencilProfile
- Extension method VisioDocument.DependencyDiagram
- Extension method VisioDocument.DuplicatePage
- Extension method VisioDocument.DuplicatePage
- Extension method VisioDocument.EnsureVisualQuality
- Extension method VisioDocument.ExportImage
- Extension method VisioDocument.ExportImages
- Extension method VisioDocument.ExportImages
- Extension method VisioDocument.Flowchart
- Extension method VisioDocument.GetVisualQualityReport
- Extension method VisioDocument.GraphDiagram
- Extension method VisioDocument.NetworkDiagram
- Extension method VisioDocument.NetworkTopologyDiagram
- Extension method VisioDocument.OrgChartDiagram
- Extension method VisioDocument.PlanStencilMigration
- Extension method VisioDocument.PolishDiagrams
- Extension method VisioDocument.SaveAsImages
- Extension method VisioDocument.SaveAsImages
- Extension method VisioDocument.SaveAsImagesAsync
- Extension method VisioDocument.SaveAsImagesAsync
- Extension method VisioDocument.SaveAsPng
- Extension method VisioDocument.SaveAsPng
- Extension method VisioDocument.SaveAsPngAsync
- Extension method VisioDocument.SaveAsPngAsync
- Extension method VisioDocument.SaveAsSvg
- Extension method VisioDocument.SaveAsSvg
- Extension method VisioDocument.SaveAsSvgAsync
- Extension method VisioDocument.SaveAsSvgAsync
- Extension method VisioDocument.SequenceDiagram
- Extension method VisioDocument.SwimlaneDiagram
- Extension method VisioDocument.TimelineDiagram
- Extension method VisioDocument.ToImage
- Extension method VisioDocument.ToImage
- Extension method VisioDocument.ToImages
- Extension method VisioDocument.ToImages
- Extension method VisioDocument.ToJpeg
- Extension method VisioDocument.ToOfficeDocumentModel
- Extension method VisioDocument.ToPng
- Extension method VisioDocument.ToSvg
- Extension method VisioDocument.ToTiff
- Extension method VisioDocument.ToWebp
- Method VisioDocumentModelExtensions.ToOfficeDocumentModel
- Method VisioDuplicationExtensions.DuplicatePage
- Method VisioDuplicationExtensions.DuplicatePage
- Method VisioImageExportExtensions.ExportImage
- Method VisioImageExportExtensions.ExportImages
- Method VisioImageExportExtensions.ExportImages
- Method VisioImageExportExtensions.SaveAsImages
- Method VisioImageExportExtensions.SaveAsImages
- Method VisioImageExportExtensions.SaveAsImagesAsync
- Method VisioImageExportExtensions.SaveAsImagesAsync
- Method VisioImageExportExtensions.ToJpeg
- Method VisioImageExportExtensions.ToTiff
- Method VisioImageExportExtensions.ToWebp
- Method VisioImageExportFluentExtensions.ToImage
- Method VisioImageExportFluentExtensions.ToImage
- Method VisioImageExportFluentExtensions.ToImages
- Method VisioImageExportFluentExtensions.ToImages
- Method VisioInspectionExtensions.CreateInspectionSnapshot
- Method VisioPngExportExtensions.SaveAsPng
- Method VisioPngExportExtensions.SaveAsPng
- Method VisioPngExportExtensions.SaveAsPngAsync
- Method VisioPngExportExtensions.SaveAsPngAsync
- Method VisioPngExportExtensions.ToPng
- Method VisioStencilMigrationExtensions.ApplyStencilMigration
- Method VisioStencilMigrationPlanApplyExtensions.ApplyStencilMigration
- Method VisioStencilMigrationPlanningExtensions.PlanStencilMigration
- Method VisioStencilProfileExtensions.CreateStencilProfile
- Method VisioSvgExportExtensions.SaveAsSvg
- Method VisioSvgExportExtensions.SaveAsSvg
- Method VisioSvgExportExtensions.SaveAsSvgAsync
- Method VisioSvgExportExtensions.SaveAsSvgAsync
- Method VisioSvgExportExtensions.ToSvg
Constructors
public VisioDocument() #Methods
public VisioPage AddBackgroundPage(String name, Double width = 8.26771653543307, Double height = 11.69291338582677, VisioMeasurementUnit unit = Inches, Nullable<Int32> id = null) #VisioPageAdds a Visio background page that can be reused by foreground pages.
Parameters
- name System.String
- Name of the background page.
- width System.Double = 8.26771653543307
- Page width.
- height System.Double = 11.69291338582677
- Page height.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for width and height.
- id System.Nullable{System.Int32} = null
- Optional page identifier.
public VisioPage AddPage(String name, Double width = 8.26771653543307, Double height = 11.69291338582677, VisioMeasurementUnit unit = Inches, Nullable<Int32> id = null) #VisioPageAdds a new page to the document.
Parameters
- name System.String
- Name of the page.
- width System.Double = 8.26771653543307
- Page width.
- height System.Double = 11.69291338582677
- Page height.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for width and height.
- id System.Nullable{System.Int32} = null
- Optional page identifier. If not specified, uses zero-based index.
public static VisioDocument Create() #VisioDocumentCreates a detached document that must be saved explicitly to a path or stream.
public static VisioDocument Create(VisioPackageType packageType) #VisioDocumentCreates a detached document for the specified Visio package family.
Parameters
- packageType OfficeIMO.Visio.VisioPackageType
public static VisioDocument Create(String path) #VisioDocumentCreates a new VisioDocument with the given save path.
Parameters
- path System.String
- Path where the document will be saved.
public static VisioDocument Create(String path, VisioPackageType packageType) #VisioDocumentCreates a new document with an explicit package family and save path.
Parameters
- path System.String
- packageType OfficeIMO.Visio.VisioPackageType
public static VisioDocument Create(Stream stream) #VisioDocumentCreates a new VisioDocument that will be saved to the provided stream.
Parameters
- stream System.IO.Stream
- Destination stream for the VSDX package.
public static VisioDocument Create(Stream stream, VisioPackageType packageType) #VisioDocumentCreates a stream-backed document with an explicit package family.
Parameters
- stream System.IO.Stream
- packageType OfficeIMO.Visio.VisioPackageType
public VisioMaster GetMaster(String nameU) #VisioMasterGets a registered master by NameU.
Parameters
- nameU System.String
public Void ImportMasters(String vsdxPath, IEnumerable<String> names = null) #VoidImports 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 System.String
- names System.Collections.Generic.IEnumerable{System.String} = null
public IReadOnlyList<VisioMaster> ImportMastersAndGet(String vsdxPath, IEnumerable<String> names = null) #IReadOnlyList<VisioMaster>Imports master names from a VSDX file and returns the registered generated masters that are natively implemented by the library.
Parameters
- vsdxPath System.String
- names System.Collections.Generic.IEnumerable{System.String} = null
public Void ImportStencilMasters(String packagePath, IEnumerable<String> names = null) #VoidImports actual master definitions from a user-supplied Visio stencil, drawing, or template package. Unlike String>), 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 System.String
- Path to a `.vssx`, `.vsdx`, or `.vstx` package.
- names System.Collections.Generic.IEnumerable{System.String} = null
- Optional filters matching master NameU, display name, relationship id, numeric id, or normalized slug.
public Void ImportStencilMasters(IEnumerable<VisioStencilShape> shapes) #VoidImports 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}
- Stencil shapes with SourcePackagePath metadata.
public IReadOnlyList<VisioMaster> ImportStencilMastersAndGet(String packagePath, IEnumerable<String> names = null) #IReadOnlyList<VisioMaster>Imports actual master definitions from a user-supplied Visio stencil, drawing, or template package and returns the registered masters.
Parameters
- packagePath System.String
- Path to a `.vssx`, `.vsdx`, or `.vstx` package.
- names System.Collections.Generic.IEnumerable{System.String} = null
- Optional filters matching master NameU, display name, relationship id, numeric id, or normalized slug.
public IReadOnlyList<VisioMaster> ImportStencilMastersAndGet(IEnumerable<VisioStencilShape> shapes) #IReadOnlyList<VisioMaster>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}
- Stencil shapes with SourcePackagePath metadata.
public static OfficePackageSignatureInfo InspectPackageSignatures(String filePath, OfficePackageSignatureInspectionOptions options = null) #OfficePackageSignatureInfoInspects a saved VSDX package through the shared dependency-light OPC signature engine.
Parameters
- filePath System.String
- options OfficeIMO.Security.OfficePackageSignatureInspectionOptions = null
public VisioSignatureInfo InspectSignatures() #VisioSignatureInfoInspects the signature carrier discovered when this document was loaded. This is structural inspection; it does not validate cryptographic trust.
public static Boolean IsBuiltinMasterSupported(String nameU) #BooleanReturns whether the library can generate a built-in master with the provided universal name.
Parameters
- nameU System.String
public IReadOnlyList<VisioMaster> LearnMastersFromVsdx(String vsdxPath, IEnumerable<String> names = null) #IReadOnlyList<VisioMaster>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 System.String
- Path to a Visio package that contains master metadata.
- names System.Collections.Generic.IEnumerable{System.String} = null
- Optional filters matching master NameU, display name, relationship id, numeric id, or normalized slug.
public static IReadOnlyList<MasterInfo> ListMastersIn(String vsdxPath) #IReadOnlyList<MasterInfo>Lists masters available in a given VSDX file (helper that proxies String)).
Parameters
- vsdxPath System.String
public static VisioDocument Load(String filePath) #VisioDocumentLoads an existing .vsdx file into a VisioDocument.
Parameters
- filePath System.String
public static VisioDocument Load(String filePath, VisioLoadOptions options) #VisioDocumentLoads an existing .vsdx file with explicit input limits.
Parameters
- filePath System.String
- options OfficeIMO.Visio.VisioLoadOptions
public static VisioDocument Load(Stream stream) #VisioDocumentLoads an existing .vsdx document from a stream.
Parameters
- stream System.IO.Stream
public static VisioDocument Load(Stream stream, VisioLoadOptions options) #VisioDocumentLoads an existing .vsdx document from a stream with explicit input limits.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Visio.VisioLoadOptions
public static async Task<VisioDocument> LoadAsync(String filePath, VisioLoadOptions options = null, CancellationToken cancellationToken = null) #Task<VisioDocument>Asynchronously loads an existing .vsdx file with optional input limits.
Parameters
- filePath System.String
- options OfficeIMO.Visio.VisioLoadOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<VisioDocument> LoadAsync(Stream stream, VisioLoadOptions options = null, CancellationToken cancellationToken = null) #Task<VisioDocument>Asynchronously loads an existing .vsdx document from a caller-owned stream with optional input limits.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Visio.VisioLoadOptions = null
- cancellationToken System.Threading.CancellationToken = null
public Void OpenInApplication(String filePath = null) #VoidOpens the associated document in the operating system's registered application.
Parameters
- filePath System.String = null
public VisioMaster RegisterMaster(VisioMaster master) #VisioMasterRegisters a master on the document so it can be reused by name.
Parameters
- master OfficeIMO.Visio.VisioMaster
public VisioMaster RegisterMaster(String nameU, VisioShape shape, String id = null) #VisioMasterRegisters a master blueprint under a NameU and returns the registered master.
Parameters
- nameU System.String
- shape OfficeIMO.Visio.VisioShape
- id System.String = null
public Void RequestRecalcOnOpen() #VoidRequests Visio to relayout and reroute connectors when the document is opened.
public Void Save(String filePath) #VoidSaves the document to a specified file path.
Parameters
- filePath System.String
public Void Save(String filePath, VisioPackageType packageType) #VoidSaves to a specified path using an explicit Visio package family.
Parameters
- filePath System.String
- packageType OfficeIMO.Visio.VisioPackageType
public Void Save(Stream stream) #VoidSaves the document once to a specified stream without changing the associated destination.
Parameters
- stream System.IO.Stream
public Task SaveAsync(CancellationToken cancellationToken = null) #TaskAsynchronously saves to the associated path or stream.
Parameters
- cancellationToken System.Threading.CancellationToken = null
public async Task SaveAsync(String filePath, CancellationToken cancellationToken = null) #TaskAsynchronously saves to a file and associates it with subsequent saves.
Parameters
- filePath System.String
- cancellationToken System.Threading.CancellationToken = null
public async Task SaveAsync(Stream stream, CancellationToken cancellationToken = null) #TaskAsynchronously saves once to a caller-owned writable stream without changing the associated destination.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public Void SaveCopy(String filePath) #VoidSaves an independent copy without changing the document's associated destination.
Parameters
- filePath System.String
public Task SaveCopyAsync(String filePath, CancellationToken cancellationToken = null) #TaskAsynchronously saves an independent copy without changing the document's associated destination.
Parameters
- filePath System.String
- cancellationToken System.Threading.CancellationToken = null
public static OfficePackageSigningResult SignPackageSignature(String filePath, IOfficeSecurityProvider securityProvider, X509Certificate2 signingCertificate, OfficePackageSigningOptions options = null) #OfficePackageSigningResultCreates and validates an OPC signature in a saved VSDX package.
Parameters
- filePath System.String
- securityProvider OfficeIMO.Security.IOfficeSecurityProvider
- signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2
- options OfficeIMO.Security.OfficePackageSigningOptions = null
public Byte[] ToBytes() #Byte[]Encodes the document using its current Visio package family.
public MemoryStream ToStream() #MemoryStreamEncodes the document in a new writable memory stream positioned at the beginning.
public Boolean TryGetMaster(String nameU, out VisioMaster master) #BooleanAttempts to find a registered master by NameU.
Parameters
- nameU System.String
- master OfficeIMO.Visio.VisioMaster@
public static OfficePackageSigningResult TrySignPackageSignature(String filePath, IOfficeSecurityProvider securityProvider, X509Certificate2 signingCertificate, OfficePackageSigningOptions options = null) #OfficePackageSigningResultAttempts OPC signature creation without throwing for an ordinary signing failure.
Parameters
- filePath System.String
- securityProvider OfficeIMO.Security.IOfficeSecurityProvider
- signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2
- options OfficeIMO.Security.OfficePackageSigningOptions = null
public IReadOnlyList<String> Validate() #IReadOnlyList<String>Validates the in-memory document model and returns authoring-time issues.
public static OfficePackageSignatureValidationReport ValidatePackageSignatures(String filePath, IOfficeSecurityProvider securityProvider, OfficePackageSignatureValidationOptions options = null) #OfficePackageSignatureValidationReportValidates a saved VSDX package through an explicitly supplied security provider.
Parameters
- filePath System.String
- securityProvider OfficeIMO.Security.IOfficeSecurityProvider
- options OfficeIMO.Security.OfficePackageSignatureValidationOptions = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String FilePath { get; } #Gets the file path associated with the document, if any.
public IReadOnlyList<VisioPage> Pages { get; } #Gets the collection of pages in the document.
public VisioPackageType PackageType { get; } #Gets the Open XML Visio package family loaded or selected for output.
public Boolean IsMacroEnabled { get; } #Gets whether the package family can retain a VBA project.
public Boolean HasVbaProject { get; } #Gets whether a preserved opaque VBA project is present.
public Boolean IsTemplate { get; } #Gets whether this document is a template package.
public Boolean IsStencil { get; } #Gets whether this document is a stencil package.
public IReadOnlyCollection<VisioMaster> Masters { get; } #Gets the masters currently registered on the document.
public VisioPackageTheme PackageTheme { get; set; } #Gets or sets package-level theme metadata preserved in the document.
public String Title { get; set; } #Gets or sets the title of the document.
public String Author { get; set; } #Gets or sets the author of the document.
public Boolean UseMastersByDefault { get; set; } #When true, shapes with a known 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 Boolean WriteMasterDeltasOnly { get; set; } #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; } #Returns the built-in master names that this library can generate natively.
public VisioSignatureMutationPolicy SignatureMutationPolicy { get; set; } #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) #VisioDocumentAdds stencil gallery review pages to an existing document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- catalog OfficeIMO.Visio.Stencils.VisioStencilCatalog
- options OfficeIMO.Visio.Stencils.VisioStencilGalleryDocumentOptions = null
public static IReadOnlyList<VisioDiagramQualityIssue> AnalyzeVisualQuality(VisioDocument document, VisioDiagramQualityOptions options = null) #IReadOnlyList<VisioDiagramQualityIssue>Analyzes every page in a document for common visual quality issues.
Parameters
- document OfficeIMO.Visio.VisioDocument
- Document to analyze.
- options OfficeIMO.Visio.VisioDiagramQualityOptions = null
- Analysis options.
public static VisioStencilMigrationResult ApplyStencilMigration(VisioDocument document, VisioStencilMigrationMap map) #VisioStencilMigrationResultApplies a stencil migration map to every foreground page in the document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- map OfficeIMO.Visio.VisioStencilMigrationMap
public static VisioStencilMigrationResult ApplyStencilMigration(VisioDocument document, VisioStencilMigrationPlan plan, VisioStencilMigrationMap map) #VisioStencilMigrationResultApplies 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
- Document to update.
- plan OfficeIMO.Visio.VisioStencilMigrationPlan
- Reviewed migration plan.
- map OfficeIMO.Visio.VisioStencilMigrationMap
- Migration map used to create the plan.
public static VisioDocument ArchitectureDiagram(VisioDocument document, String pageName, Action<VisioArchitectureDiagramBuilder> configure) #VisioDocumentAdds a semantic architecture diagram page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioArchitectureDiagramBuilder}
public static VisioFluentDocument AsFluent(VisioDocument doc) #VisioFluentDocumentWraps the document in a VisioFluentDocument for fluent configuration.
Parameters
- doc OfficeIMO.Visio.VisioDocument
- The document to wrap.
public static VisioDocument BlockDiagram(VisioDocument document, String pageName, Action<VisioBlockDiagramBuilder> configure) #VisioDocumentAdds a semantic block diagram page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioBlockDiagramBuilder}
public static VisioInspectionSnapshot CreateInspectionSnapshot(VisioDocument document) #VisioInspectionSnapshotCreates a stable, data-oriented snapshot of the document structure.
Parameters
- document OfficeIMO.Visio.VisioDocument
public static VisioStencilProfile CreateStencilProfile(VisioDocument document) #VisioStencilProfileCreates a deterministic stencil usage profile for the document.
Parameters
- document OfficeIMO.Visio.VisioDocument
public static VisioDocument DependencyDiagram(VisioDocument document, String pageName, Action<VisioDependencyDiagramBuilder> configure) #VisioDocumentAdds an automatically layered dependency diagram page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioDependencyDiagramBuilder}
public static VisioPage DuplicatePage(VisioDocument document, VisioPage sourcePage, String name = null) #VisioPageDuplicates a page in the same document, preserving page settings, layers, shapes, and internal connectors.
Parameters
- document OfficeIMO.Visio.VisioDocument
- Document that owns the source page and receives the duplicate.
- sourcePage OfficeIMO.Visio.VisioPage
- Page to duplicate.
- name System.String = null
- Optional name for the duplicate. When omitted, a unique copy name is generated.
Returns
The duplicated page.
public static VisioPage DuplicatePage(VisioDocument document, VisioPage sourcePage, VisioPageDuplicationOptions options) #VisioPageDuplicates a page in the same document, preserving page settings, layers, shapes, and internal connectors.
Parameters
- document OfficeIMO.Visio.VisioDocument
- Document that owns the source page and receives the duplicate.
- sourcePage OfficeIMO.Visio.VisioPage
- Page to duplicate.
- options OfficeIMO.Visio.VisioPageDuplicationOptions
- Optional duplication settings.
Returns
The duplicated page.
public static VisioDocument EnsureVisualQuality(VisioDocument document, VisioDiagramQualityOptions options = null, VisioDiagramQualityIssueSeverity minimumSeverity = Warning) #VisioDocumentThrows when a document contains visual quality issues at or above the requested severity.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioDiagramQualityOptions = null
- minimumSeverity OfficeIMO.Visio.VisioDiagramQualityIssueSeverity = Warning
public static OfficeImageExportResult ExportImage(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #OfficeImageExportResultExports the selected document page to a supported raster format or SVG.
Parameters
- arg1 OfficeIMO.Visio.VisioDocument
- arg2 OfficeIMO.Drawing.OfficeImageExportFormat
- arg3 OfficeIMO.Visio.VisioImageExportOptions = null
- arg4 System.Threading.CancellationToken = null
public static IReadOnlyList<OfficeImageExportResult> ExportImages(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions options = null) #IReadOnlyList<OfficeImageExportResult>Exports a selected range of document pages to a supported raster format or SVG.
Parameters
- document OfficeIMO.Visio.VisioDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Visio.VisioImageExportOptions = null
public static Void ExportImages(VisioDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #VoidStreams selected document page images without retaining earlier payloads.
Parameters
- document OfficeIMO.Visio.VisioDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- consumer OfficeIMO.Drawing.OfficeImageExportConsumer
- options OfficeIMO.Visio.VisioImageExportOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static VisioDocument Flowchart(VisioDocument document, String pageName, Action<VisioFlowchartBuilder> configure) #VisioDocumentAdds a semantic flowchart page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioFlowchartBuilder}
public static VisioDiagramQualityReport GetVisualQualityReport(VisioDocument document, VisioDiagramQualityOptions options = null) #VisioDiagramQualityReportCreates a visual quality report for every page in a document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioDiagramQualityOptions = null
public static VisioDocument GraphDiagram(VisioDocument document, String pageName, Action<VisioGraphDiagramBuilder> configure) #VisioDocumentAdds an automatically laid out generic graph page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioGraphDiagramBuilder}
public static VisioDocument NetworkDiagram(VisioDocument document, String pageName, Action<VisioNetworkDiagramBuilder> configure) #VisioDocumentAdds a semantic network diagram page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioNetworkDiagramBuilder}
public static VisioDocument NetworkTopologyDiagram(VisioDocument document, String pageName, Action<VisioNetworkTopologyDiagramBuilder> configure) #VisioDocumentAdds a semantic network topology page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioNetworkTopologyDiagramBuilder}
public static VisioDocument OrgChartDiagram(VisioDocument document, String pageName, Action<VisioOrgChartDiagramBuilder> configure) #VisioDocumentAdds a semantic org chart page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioOrgChartDiagramBuilder}
public static VisioStencilMigrationPlan PlanStencilMigration(VisioDocument document, VisioStencilMigrationMap map) #VisioStencilMigrationPlanPlans a stencil migration map for every foreground page in the document without modifying the document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- map OfficeIMO.Visio.VisioStencilMigrationMap
public static VisioDocument PolishDiagrams(VisioDocument document, VisioDiagramPolishOptions options = null) #VisioDocumentApplies a deterministic cleanup pass to every foreground page in the document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- Document whose pages should be polished.
- options OfficeIMO.Visio.VisioDiagramPolishOptions = null
- Optional polish settings.
public static IReadOnlyList<OfficeImageExportResult> SaveAsImages(VisioDocument document, String folderPath, VisioImageExportOptions options = null) #IReadOnlyList<OfficeImageExportResult>Saves selected document pages to a folder as PNG files.
Parameters
- document OfficeIMO.Visio.VisioDocument
- folderPath System.String
- options OfficeIMO.Visio.VisioImageExportOptions = null
public static IReadOnlyList<OfficeImageExportResult> SaveAsImages(VisioDocument document, String folderPath, OfficeImageExportFormat format, VisioImageExportOptions options = null) #IReadOnlyList<OfficeImageExportResult>Saves selected document pages to a folder in the requested image format.
Parameters
- document OfficeIMO.Visio.VisioDocument
- folderPath System.String
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Visio.VisioImageExportOptions = null
public static Task<IReadOnlyList<OfficeImageExportResult>> SaveAsImagesAsync(VisioDocument document, String folderPath, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #Task<IReadOnlyList<OfficeImageExportResult>>Asynchronously saves selected document pages to a folder as PNG files.
Parameters
- document OfficeIMO.Visio.VisioDocument
- folderPath System.String
- options OfficeIMO.Visio.VisioImageExportOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static Task<IReadOnlyList<OfficeImageExportResult>> SaveAsImagesAsync(VisioDocument document, String folderPath, OfficeImageExportFormat format, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #Task<IReadOnlyList<OfficeImageExportResult>>Asynchronously saves selected document pages to a folder in the requested image format.
Parameters
- document OfficeIMO.Visio.VisioDocument
- folderPath System.String
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Visio.VisioImageExportOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static OfficeImageExportResult SaveAsPng(VisioDocument document, String path, VisioPngSaveOptions options = null) #OfficeImageExportResultSaves the selected document page as PNG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioPngSaveOptions = null
public static OfficeImageExportResult SaveAsPng(VisioDocument document, Stream stream, VisioPngSaveOptions options = null) #OfficeImageExportResultWrites the selected document page as PNG to a stream without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- stream System.IO.Stream
- options OfficeIMO.Visio.VisioPngSaveOptions = null
public static async Task<OfficeImageExportResult> SaveAsPngAsync(VisioDocument document, String path, VisioPngSaveOptions options = null, CancellationToken cancellationToken = null) #Task<OfficeImageExportResult>Asynchronously saves the selected document page as PNG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioPngSaveOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<OfficeImageExportResult> SaveAsPngAsync(VisioDocument document, Stream stream, VisioPngSaveOptions options = null, CancellationToken cancellationToken = null) #Task<OfficeImageExportResult>Asynchronously writes the selected document page as PNG to a stream without closing it.
Parameters
- document OfficeIMO.Visio.VisioDocument
- stream System.IO.Stream
- options OfficeIMO.Visio.VisioPngSaveOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static OfficeImageExportResult SaveAsSvg(VisioDocument document, String path, VisioSvgSaveOptions options = null) #OfficeImageExportResultSaves the selected document page as SVG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
public static OfficeImageExportResult SaveAsSvg(VisioDocument document, Stream stream, VisioSvgSaveOptions options = null) #OfficeImageExportResultWrites the selected document page as SVG to a stream without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- stream System.IO.Stream
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
public static async Task<OfficeImageExportResult> SaveAsSvgAsync(VisioDocument document, String path, VisioSvgSaveOptions options = null, CancellationToken cancellationToken = null) #Task<OfficeImageExportResult>Asynchronously saves the selected document page as SVG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<OfficeImageExportResult> SaveAsSvgAsync(VisioDocument document, Stream stream, VisioSvgSaveOptions options = null, CancellationToken cancellationToken = null) #Task<OfficeImageExportResult>Asynchronously writes the selected document page as SVG to a stream without closing it.
Parameters
- document OfficeIMO.Visio.VisioDocument
- stream System.IO.Stream
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static VisioDocument SequenceDiagram(VisioDocument document, String pageName, Action<VisioSequenceDiagramBuilder> configure) #VisioDocumentAdds a semantic sequence diagram page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioSequenceDiagramBuilder}
public static VisioDocument SwimlaneDiagram(VisioDocument document, String pageName, Action<VisioSwimlaneDiagramBuilder> configure) #VisioDocumentAdds a semantic swimlane diagram page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioSwimlaneDiagramBuilder}
public static VisioDocument TimelineDiagram(VisioDocument document, String pageName, Action<VisioTimelineDiagramBuilder> configure) #VisioDocumentAdds a semantic timeline page and returns the document for chaining.
Parameters
- document OfficeIMO.Visio.VisioDocument
- pageName System.String
- configure System.Action{OfficeIMO.Visio.Diagrams.VisioTimelineDiagramBuilder}
public static VisioDocumentImageExportBuilder ToImage(VisioDocument document) #VisioDocumentImageExportBuilderStarts fluent image export for one selected page in this Visio document.
Parameters
- document OfficeIMO.Visio.VisioDocument
public static VisioDocumentImageExportBuilder ToImage(VisioDocument document, VisioImageExportOptions options) #VisioDocumentImageExportBuilderStarts fluent selected-page export using a cloned options snapshot.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioImageExportOptions
public static VisioDocumentImageBatchExportBuilder ToImages(VisioDocument document) #VisioDocumentImageBatchExportBuilderStarts fluent batch image export for pages in this Visio document.
Parameters
- document OfficeIMO.Visio.VisioDocument
public static VisioDocumentImageBatchExportBuilder ToImages(VisioDocument document, VisioImageExportOptions options) #VisioDocumentImageBatchExportBuilderStarts fluent page-batch export using a cloned options snapshot.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioImageExportOptions
public static Byte[] ToJpeg(VisioDocument document, VisioImageExportOptions options = null) #Byte[]Renders the selected Visio document page to JPEG bytes.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioImageExportOptions = null
public static OfficeDocumentModel ToOfficeDocumentModel(VisioDocument document, String sourceName = null, VisioDocumentProjectionOptions options = null, CancellationToken cancellationToken = null) #OfficeDocumentModelProjects an already loaded Visio document into the neutral document model.
Parameters
- document OfficeIMO.Visio.VisioDocument
- sourceName System.String = null
- options OfficeIMO.Visio.VisioDocumentProjectionOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static Byte[] ToPng(VisioDocument document, VisioPngSaveOptions options = null) #Byte[]Renders the selected document page to PNG bytes without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioPngSaveOptions = null
public static String ToSvg(VisioDocument document, VisioSvgSaveOptions options = null) #StringRenders the selected document page to SVG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
public static Byte[] ToTiff(VisioDocument document, VisioImageExportOptions options = null) #Byte[]Renders the selected Visio document page to TIFF bytes.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioImageExportOptions = null
public static Byte[] ToWebp(VisioDocument document, VisioImageExportOptions options = null) #Byte[]Renders the selected Visio document page to lossless WebP bytes.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioImageExportOptions = null