API Reference
Class
VisioDocumentImageExportBuilder
Fluent image export for one selected Visio document page.
Inheritance
- OfficeImageExportBuilder<VisioDocumentImageExportBuilder, VisioImageExportOptions>
- VisioDocumentImageExportBuilder
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.ToImage
- Extension method VisioDocument.ToImage
- Method VisioDocumentImageExportBuilder.As
- Method VisioDocumentImageExportBuilder.AsJpeg
- Method VisioDocumentImageExportBuilder.AsPng
- Method VisioDocumentImageExportBuilder.AsSvg
- Method VisioDocumentImageExportBuilder.AsTiff
- Method VisioDocumentImageExportBuilder.AsWebp
- Method VisioDocumentImageExportBuilder.AtDpi
- Method VisioDocumentImageExportBuilder.ConfigureOptions
- Method VisioDocumentImageExportBuilder.FitWithin
- Method VisioDocumentImageExportBuilder.FitWithinHeight
- Method VisioDocumentImageExportBuilder.FitWithinWidth
- Method VisioDocumentImageExportBuilder.ForPreview
- Method VisioDocumentImageExportBuilder.ForPrint
- Method VisioDocumentImageExportBuilder.IncludeConnectorLabels
- Method VisioDocumentImageExportBuilder.IncludeStencilArtwork
- Method VisioDocumentImageExportBuilder.IncludeText
- Method VisioDocumentImageExportBuilder.OnFileConflict
- Method VisioDocumentImageExportBuilder.OnRasterOverflow
- Method VisioDocumentImageExportBuilder.Page
- Method VisioDocumentImageExportBuilder.ResolveConnectorLabelOverlaps
- Method VisioDocumentImageExportBuilder.WithBackground
- Method VisioDocumentImageExportBuilder.WithBackground
- Method VisioDocumentImageExportBuilder.WithFont
- Method VisioDocumentImageExportBuilder.WithFonts
- Method VisioDocumentImageExportBuilder.WithImageCodec
- Method VisioDocumentImageExportBuilder.WithMaximumRasterPixels
- Method VisioDocumentImageExportBuilder.WithoutSizeLimit
- Method VisioDocumentImageExportBuilder.WithPolicy
- Method VisioDocumentImageExportBuilder.WithProgress
- Method VisioDocumentImageExportBuilder.WithRasterEncoding
- Method VisioDocumentImageExportBuilder.WithRenderTimeout
- Method VisioDocumentImageExportBuilder.WithScale
- Method VisioDocumentImageExportBuilder.WithTextShaping
- Method VisioImageExportFluentExtensions.ToImage
- Method VisioImageExportFluentExtensions.ToImage
Methods
public VisioDocumentImageExportBuilder IncludeConnectorLabels(Boolean include = true) #Returns:
VisioDocumentImageExportBuilderIncludes or excludes connector labels.
Parameters
- include System.Boolean = true
public VisioDocumentImageExportBuilder IncludeStencilArtwork(Boolean include = true) #Returns:
VisioDocumentImageExportBuilderIncludes or excludes built-in stencil artwork.
Parameters
- include System.Boolean = true
public VisioDocumentImageExportBuilder IncludeText(Boolean include = true) #Returns:
VisioDocumentImageExportBuilderIncludes or excludes shape and connector text.
Parameters
- include System.Boolean = true
public VisioDocumentImageExportBuilder Page(Int32 pageIndex) #Returns:
VisioDocumentImageExportBuilderSelects the zero-based document page to export.
Parameters
- pageIndex System.Int32
public VisioDocumentImageExportBuilder ResolveConnectorLabelOverlaps(Boolean resolve = true) #Returns:
VisioDocumentImageExportBuilderEnables or disables connector-label overlap resolution.
Parameters
- resolve System.Boolean = true
Inherited Methods
public VisioDocumentImageExportBuilder As(OfficeImageExportFormat format) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public VisioDocumentImageExportBuilder AsJpeg() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder AsPng() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder AsSvg() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder AsTiff() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder AsWebp() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder AtDpi(Double dpi) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public VisioDocumentImageExportBuilder ConfigureOptions(Action<VisioImageExportOptions> configure) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<VisioImageExportOptions>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Export 2 overloads
public OfficeImageExportResult Export() #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OfficeImageExportResult Export(CancellationToken cancellationToken) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken
public async Task<OfficeImageExportResult> ExportAsync(CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = null
public VisioDocumentImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public VisioDocumentImageExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public VisioDocumentImageExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public VisioDocumentImageExportBuilder ForPreview() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder ForPrint(Double dpi = 300) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public VisioDocumentImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public VisioDocumentImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
Save 2 overloads
public OfficeImageExportResult Save(String path) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
public OfficeImageExportResult Save(Stream stream) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- stream Stream
SaveAsync 2 overloads
public async Task<OfficeImageExportResult> SaveAsync(String path, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
- cancellationToken CancellationToken = null
public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- stream Stream
- cancellationToken CancellationToken = null
WithBackground 2 overloads
public VisioDocumentImageExportBuilder WithBackground(OfficeColor color) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public VisioDocumentImageExportBuilder WithBackground(String color) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public VisioDocumentImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public VisioDocumentImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public VisioDocumentImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public VisioDocumentImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public VisioDocumentImageExportBuilder WithoutSizeLimit() #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioDocumentImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public VisioDocumentImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public VisioDocumentImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public VisioDocumentImageExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public VisioDocumentImageExportBuilder WithScale(Double scale) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public VisioDocumentImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
VisioDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null