API Reference
Class
VisioDocumentImageBatchExportBuilder
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.ForPreview
- Method VisioDocumentImageBatchExportBuilder.ForPrint
- Method VisioDocumentImageBatchExportBuilder.FromPage
- Method VisioDocumentImageBatchExportBuilder.IncludeText
- Method VisioDocumentImageBatchExportBuilder.OnFileConflict
- Method VisioDocumentImageBatchExportBuilder.OnRasterOverflow
- Method VisioDocumentImageBatchExportBuilder.TakePages
- Method VisioDocumentImageBatchExportBuilder.WithBackground
- Method VisioDocumentImageBatchExportBuilder.WithBatchLimits
- Method VisioDocumentImageBatchExportBuilder.WithFont
- Method VisioDocumentImageBatchExportBuilder.WithFonts
- Method VisioDocumentImageBatchExportBuilder.WithImageCodec
- Method VisioDocumentImageBatchExportBuilder.WithMaximumConcurrency
- Method VisioDocumentImageBatchExportBuilder.WithMaximumRasterPixels
- Method VisioDocumentImageBatchExportBuilder.WithPolicy
- Method VisioDocumentImageBatchExportBuilder.WithProgress
- Method VisioDocumentImageBatchExportBuilder.WithRasterEncoding
- Method VisioDocumentImageBatchExportBuilder.WithScale
- Method VisioImageExportFluentExtensions.ToImages
- Method VisioImageExportFluentExtensions.ToImages
Methods
public VisioDocumentImageBatchExportBuilder AllPages() #Returns:
VisioDocumentImageBatchExportBuilderExports all pages from the beginning of the document.
public VisioDocumentImageBatchExportBuilder FromPage(Int32 pageIndex) #Returns:
VisioDocumentImageBatchExportBuilderExports from the specified zero-based page index.
Parameters
- pageIndex System.Int32
public VisioDocumentImageBatchExportBuilder IncludeText(Boolean include = true) #Returns:
VisioDocumentImageBatchExportBuilderIncludes or excludes shape and connector text.
Parameters
- include System.Boolean = true
public VisioDocumentImageBatchExportBuilder TakePages(Int32 pageCount) #Returns:
VisioDocumentImageBatchExportBuilderLimits batch output to the requested number of pages.
Parameters
- pageCount System.Int32
Inherited Methods
public VisioDocumentImageBatchExportBuilder As(OfficeImageExportFormat format) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public VisioDocumentImageBatchExportBuilder AsJpeg() #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageBatchExportBuilder AsPng() #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageBatchExportBuilder AsSvg() #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageBatchExportBuilder AsTiff() #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageBatchExportBuilder AsWebp() #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageBatchExportBuilder AtDpi(Double dpi) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public IReadOnlyList<OfficeImageExportResult> Export() #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public async Task<IReadOnlyList<OfficeImageExportResult>> ExportAsync(CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = null
public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = null) #Returns:
VoidInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportConsumer
- cancellationToken CancellationToken = null
public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = null) #Returns:
TaskInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportAsyncConsumer
- cancellationToken CancellationToken = null
public VisioDocumentImageBatchExportBuilder ForPreview() #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageBatchExportBuilder ForPrint(Double dpi = 300) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public VisioDocumentImageBatchExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public VisioDocumentImageBatchExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<IReadOnlyList<OfficeImageExportResult>> SaveAsync(String folderPath, CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = null
public OfficeImageExportBatchSaveResult SaveFiles(String folderPath) #Returns:
OfficeImageExportBatchSaveResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<OfficeImageExportBatchSaveResult> SaveFilesAsync(String folderPath, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportBatchSaveResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = null
public VisioDocumentImageBatchExportBuilder WithBackground(String color) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public VisioDocumentImageBatchExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public VisioDocumentImageBatchExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public VisioDocumentImageBatchExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public VisioDocumentImageBatchExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public VisioDocumentImageBatchExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public VisioDocumentImageBatchExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public VisioDocumentImageBatchExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public VisioDocumentImageBatchExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public VisioDocumentImageBatchExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public VisioDocumentImageBatchExportBuilder WithScale(Double scale) #Returns:
VisioDocumentImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double