Get Started

API Reference

Class

VisioImageExportExtensions

Edit on GitHub
Namespace OfficeIMO.Visio
Assembly OfficeIMO.Visio
Source OfficeIMO.Visio/VisioImageExportExtensions.cs:15
Modifiers static

Format-neutral image export for Visio documents and pages.

Inheritance

  • Object
  • VisioImageExportExtensions

Methods

ExportImage 2 overloads
public static OfficeImageExportResult ExportImage(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:23
Returns: OfficeImageExportResult

Exports a Visio page to a supported raster format or SVG.

Parameters

arg1 OfficeIMO.Visio.VisioPage requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = null optionalposition: 3
ExportImage(OfficeIMO.Visio.VisioDocument arg1, OfficeIMO.Drawing.OfficeImageExportFormat arg2, OfficeIMO.Visio.VisioImageExportOptions arg3, System.Threading.CancellationToken arg4) #

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

Parameters

arg1 OfficeIMO.Visio.VisioDocument required
arg2 OfficeIMO.Drawing.OfficeImageExportFormat required
arg3 OfficeIMO.Visio.VisioImageExportOptions required
arg4 System.Threading.CancellationToken required
ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(VisioDocument document, OfficeImageExportFormat format, VisioImageExportOptions options = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:45
Returns: IReadOnlyList<OfficeImageExportResult>

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

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 2
public static Void ExportImages(VisioDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:57
Returns: Void

Streams selected document page images without retaining earlier payloads.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 2
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
SaveAsImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> SaveAsImages(VisioDocument document, String folderPath, VisioImageExportOptions options = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:116
Returns: IReadOnlyList<OfficeImageExportResult>

Saves selected document pages to a folder as PNG files.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
folderPath System.String requiredposition: 1
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 2
public static IReadOnlyList<OfficeImageExportResult> SaveAsImages(VisioDocument document, String folderPath, OfficeImageExportFormat format, VisioImageExportOptions options = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:124
Returns: IReadOnlyList<OfficeImageExportResult>

Saves selected document pages to a folder in the requested image format.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
folderPath System.String requiredposition: 1
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 2
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 3
SaveAsImagesAsync 2 overloads
public static Task<IReadOnlyList<OfficeImageExportResult>> SaveAsImagesAsync(VisioDocument document, String folderPath, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:132
Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Asynchronously saves selected document pages to a folder as PNG files.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
folderPath System.String requiredposition: 1
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static Task<IReadOnlyList<OfficeImageExportResult>> SaveAsImagesAsync(VisioDocument document, String folderPath, OfficeImageExportFormat format, VisioImageExportOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:141
Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Asynchronously saves selected document pages to a folder in the requested image format.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
folderPath System.String requiredposition: 1
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 2
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ToJpeg 2 overloads
public static Byte[] ToJpeg(VisioDocument document, VisioImageExportOptions options = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:93
Returns: Byte[]

Renders a Visio page to JPEG bytes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 1
ToJpeg(OfficeIMO.Visio.VisioDocument document, OfficeIMO.Visio.VisioImageExportOptions options) #

Renders the selected Visio document page to JPEG bytes.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions required
ToTiff 2 overloads
public static Byte[] ToTiff(VisioDocument document, VisioImageExportOptions options = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:101
Returns: Byte[]

Renders a Visio page to TIFF bytes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 1
ToTiff(OfficeIMO.Visio.VisioDocument document, OfficeIMO.Visio.VisioImageExportOptions options) #

Renders the selected Visio document page to TIFF bytes.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions required
ToWebp 2 overloads
public static Byte[] ToWebp(VisioDocument document, VisioImageExportOptions options = null) #
OfficeIMO.Visio/VisioImageExportExtensions.cs:109
Returns: Byte[]

Renders a Visio page to lossless WebP bytes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
options OfficeIMO.Visio.VisioImageExportOptions = null optionalposition: 1
ToWebp(OfficeIMO.Visio.VisioDocument document, OfficeIMO.Visio.VisioImageExportOptions options) #

Renders the selected Visio document page to lossless WebP bytes.

Parameters

document OfficeIMO.Visio.VisioDocument required
options OfficeIMO.Visio.VisioImageExportOptions required