API Reference

Class

VisioDocumentImageBatchExportBuilder

Edit on GitHub

Namespace OfficeIMO.Visio

Assembly OfficeIMO.Visio

Source OfficeIMO.Visio/VisioImageExportBuilder.cs:71

Base OfficeImageExportBatchBuilder<VisioDocumentImageBatchExportBuilder, VisioImageExportOptions>

Modifiers sealed

Fluent batch image export for Visio document pages.

Inheritance

OfficeImageExportBatchBuilder<VisioDocumentImageBatchExportBuilder, VisioImageExportOptions>
VisioDocumentImageBatchExportBuilder

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

Extension method VisioDocument.ToImages
Extension method VisioDocument.ToImages
Method VisioDocumentImageBatchExportBuilder.AllPages
Method VisioDocumentImageBatchExportBuilder.As
Method VisioDocumentImageBatchExportBuilder.AsJpeg
Method VisioDocumentImageBatchExportBuilder.AsPng
Method VisioDocumentImageBatchExportBuilder.AsSvg
Method VisioDocumentImageBatchExportBuilder.AsTiff
Method VisioDocumentImageBatchExportBuilder.AsWebp
Method VisioDocumentImageBatchExportBuilder.AtDpi
Method VisioDocumentImageBatchExportBuilder.ConfigureOptions
Method VisioDocumentImageBatchExportBuilder.FitWithin
Method VisioDocumentImageBatchExportBuilder.FitWithinHeight
Method VisioDocumentImageBatchExportBuilder.FitWithinWidth
Method VisioDocumentImageBatchExportBuilder.ForPreview
Method VisioDocumentImageBatchExportBuilder.ForPrint
Method VisioDocumentImageBatchExportBuilder.FromPage
Method VisioDocumentImageBatchExportBuilder.IncludeConnectorLabels
Method VisioDocumentImageBatchExportBuilder.IncludeStencilArtwork
Method VisioDocumentImageBatchExportBuilder.IncludeText
Method VisioDocumentImageBatchExportBuilder.OnFileConflict
Method VisioDocumentImageBatchExportBuilder.OnRasterOverflow
Method VisioDocumentImageBatchExportBuilder.ResolveConnectorLabelOverlaps
Method VisioDocumentImageBatchExportBuilder.TakePages
Method VisioDocumentImageBatchExportBuilder.WithBackground
Method VisioDocumentImageBatchExportBuilder.WithBackground
Method VisioDocumentImageBatchExportBuilder.WithBatchLimits
Method VisioDocumentImageBatchExportBuilder.WithFont
Method VisioDocumentImageBatchExportBuilder.WithFonts
Method VisioDocumentImageBatchExportBuilder.WithImageCodec
Method VisioDocumentImageBatchExportBuilder.WithMaximumConcurrency
Method VisioDocumentImageBatchExportBuilder.WithMaximumRasterPixels
Method VisioDocumentImageBatchExportBuilder.WithoutSizeLimit
Method VisioDocumentImageBatchExportBuilder.WithPolicy
Method VisioDocumentImageBatchExportBuilder.WithProgress
Method VisioDocumentImageBatchExportBuilder.WithRasterEncoding
Method VisioDocumentImageBatchExportBuilder.WithRenderTimeout
Method VisioDocumentImageBatchExportBuilder.WithScale
Method VisioDocumentImageBatchExportBuilder.WithTextShaping
Method VisioImageExportFluentExtensions.ToImages
Method VisioImageExportFluentExtensions.ToImages

Methods

public VisioDocumentImageBatchExportBuilder AllPages() #

OfficeIMO.Visio/VisioImageExportBuilder.cs:85

Returns: VisioDocumentImageBatchExportBuilder

Exports all pages from the beginning of the document.

public VisioDocumentImageBatchExportBuilder FromPage(Int32 pageIndex) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:71

Returns: VisioDocumentImageBatchExportBuilder

Exports from the specified zero-based page index.

Parameters

pageIndex System.Int32 requiredposition: 0

public VisioDocumentImageBatchExportBuilder IncludeConnectorLabels(Boolean include = true) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:97

Returns: VisioDocumentImageBatchExportBuilder

Includes or excludes connector labels.

Parameters

include System.Boolean = true optionalposition: 0

public VisioDocumentImageBatchExportBuilder IncludeStencilArtwork(Boolean include = true) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:94

Returns: VisioDocumentImageBatchExportBuilder

Includes or excludes built-in stencil artwork.

Parameters

include System.Boolean = true optionalposition: 0

public VisioDocumentImageBatchExportBuilder IncludeText(Boolean include = true) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:91

Returns: VisioDocumentImageBatchExportBuilder

Includes or excludes shape and connector text.

Parameters

include System.Boolean = true optionalposition: 0

public VisioDocumentImageBatchExportBuilder ResolveConnectorLabelOverlaps(Boolean resolve = true) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:100

Returns: VisioDocumentImageBatchExportBuilder

Enables or disables connector-label overlap resolution.

Parameters

resolve System.Boolean = true optionalposition: 0

public VisioDocumentImageBatchExportBuilder TakePages(Int32 pageCount) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:78

Returns: VisioDocumentImageBatchExportBuilder

Limits batch output to the requested number of pages.

Parameters

pageCount System.Int32 requiredposition: 0

Inherited Methods

public VisioDocumentImageBatchExportBuilder As(OfficeImageExportFormat format) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:38

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

format OfficeImageExportFormat requiredposition: 0

public VisioDocumentImageBatchExportBuilder AsJpeg() #

OfficeIMO.Visio/Diagrams/VisioNetworkDiagramVisuals.cs:148

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder AsPng() #

OfficeIMO.Visio/Diagrams/VisioNetworkDiagramVisuals.cs:116

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder AsSvg() #

OfficeIMO.Visio/Diagrams/VisioNetworkDiagramVisuals.cs:132

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder AsTiff() #

OfficeIMO.Visio/Diagrams/VisioNetworkDiagramVisuals.cs:151

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder AsWebp() #

OfficeIMO.Visio/Diagrams/VisioNetworkDiagramVisuals.cs:165

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder AtDpi(Double dpi) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:35

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

dpi Double requiredposition: 0

public VisioDocumentImageBatchExportBuilder ConfigureOptions(Action<VisioImageExportOptions> configure) #

OfficeIMO.Visio/Diagrams/VisioNetworkDiagramVisuals.cs:96

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

configure Action<VisioImageExportOptions> requiredposition: 0

public override Boolean Equals(Object obj) #

OfficeIMO.Visio/Routing/VisioConnectorLabelPlacement.cs:53

Returns: Boolean

Inherited from Object

Parameters

obj Object requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Export() #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:99

Returns: IReadOnlyList<OfficeImageExportResult>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public async Task<IReadOnlyList<OfficeImageExportResult>> ExportAsync(CancellationToken cancellationToken = null) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:102

Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

cancellationToken CancellationToken = null optionalposition: 0

public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = null) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:105

Returns: Void

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

consumer OfficeImageExportConsumer requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = null) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:108

Returns: Task

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

consumer OfficeImageExportAsyncConsumer requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public VisioDocumentImageBatchExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:23

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumWidth Int32 requiredposition: 0
maximumHeight Int32 requiredposition: 1

public VisioDocumentImageBatchExportBuilder FitWithinHeight(Int32 maximumHeight) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:29

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumHeight Int32 requiredposition: 0

public VisioDocumentImageBatchExportBuilder FitWithinWidth(Int32 maximumWidth) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:26

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumWidth Int32 requiredposition: 0

public VisioDocumentImageBatchExportBuilder ForPreview() #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:82

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder ForPrint(Double dpi = 300) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:114

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

dpi Double = 300 optionalposition: 0

public override Int32 GetHashCode() #

OfficeIMO.Visio/Routing/VisioConnectorLabelPlacement.cs:55

Returns: Int32

Inherited from Object

public Type GetType() #

OfficeIMO.Visio/Routing/VisioConnectorLabelPlacement.cs:39

Returns: Type

Inherited from Object

public VisioDocumentImageBatchExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:82

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public VisioDocumentImageBatchExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:64

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

behavior OfficeRasterOverflowBehavior requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:111

Returns: IReadOnlyList<OfficeImageExportResult>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0

public async Task<IReadOnlyList<OfficeImageExportResult>> SaveAsync(String folderPath, CancellationToken cancellationToken = null)

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:117

Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public OfficeImageExportBatchSaveResult SaveFiles(String folderPath) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:114

Returns: OfficeImageExportBatchSaveResult

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0

public async Task<OfficeImageExportBatchSaveResult> SaveFilesAsync(String folderPath, CancellationToken cancellationToken = null)

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:117

Returns: Task<OfficeImageExportBatchSaveResult>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public override String ToString() #

OfficeIMO.Visio/Routing/VisioConnectorLabelPlacement.cs:50

Returns: String

Inherited from Object

WithBackground 2 overloads

public VisioDocumentImageBatchExportBuilder WithBackground(OfficeColor color) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:38

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

color OfficeColor requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithBackground(String color) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:41

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

color String requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes)

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:44

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumOutputCount Int32 requiredposition: 0
maximumTotalRasterPixels Int64 requiredposition: 1
maximumTotalEncodedBytes Int64 requiredposition: 2

public VisioDocumentImageBatchExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:70

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

familyName String requiredposition: 0
data Byte[] requiredposition: 1
style OfficeFontStyle = Regular optionalposition: 2

public VisioDocumentImageBatchExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:73

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:67

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:61

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumDegreeOfParallelism Int32 requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:44

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumPixels Int64 requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithoutSizeLimit() #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:32

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public VisioDocumentImageBatchExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:79

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:79

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:41

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithRenderTimeout(TimeSpan timeout) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:76

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

timeout TimeSpan requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithScale(Double scale) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:20

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

scale Double requiredposition: 0

public VisioDocumentImageBatchExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #

OfficeIMO.Visio/Diagrams/VisioNetworkRecords.cs:76

Returns: VisioDocumentImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

provider IOfficeTextShapingProvider requiredposition: 0
language String = null optionalposition: 1