API Reference
Class
VisioPageImageExportBuilder
Fluent image export for a Visio page.
Inheritance
- OfficeImageExportBuilder<VisioPageImageExportBuilder, VisioImageExportOptions>
- VisioPageImageExportBuilder
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 VisioPage.ToImage
- Extension method VisioPage.ToImage
- Method VisioPageImageExportBuilder.As
- Method VisioPageImageExportBuilder.AsJpeg
- Method VisioPageImageExportBuilder.AsPng
- Method VisioPageImageExportBuilder.AsSvg
- Method VisioPageImageExportBuilder.AsTiff
- Method VisioPageImageExportBuilder.AsWebp
- Method VisioPageImageExportBuilder.AtDpi
- Method VisioPageImageExportBuilder.ForPreview
- Method VisioPageImageExportBuilder.ForPrint
- Method VisioPageImageExportBuilder.IncludeConnectorLabels
- Method VisioPageImageExportBuilder.IncludeStencilArtwork
- Method VisioPageImageExportBuilder.IncludeText
- Method VisioPageImageExportBuilder.OnFileConflict
- Method VisioPageImageExportBuilder.OnRasterOverflow
- Method VisioPageImageExportBuilder.WithBackground
- Method VisioPageImageExportBuilder.WithFont
- Method VisioPageImageExportBuilder.WithFonts
- Method VisioPageImageExportBuilder.WithImageCodec
- Method VisioPageImageExportBuilder.WithMaximumRasterPixels
- Method VisioPageImageExportBuilder.WithPolicy
- Method VisioPageImageExportBuilder.WithProgress
- Method VisioPageImageExportBuilder.WithRasterEncoding
- Method VisioPageImageExportBuilder.WithScale
Methods
public VisioPageImageExportBuilder IncludeConnectorLabels(Boolean include = true) #Returns:
VisioPageImageExportBuilderIncludes or excludes connector labels.
Parameters
- include System.Boolean = true
public VisioPageImageExportBuilder IncludeStencilArtwork(Boolean include = true) #Returns:
VisioPageImageExportBuilderIncludes or excludes built-in stencil artwork.
Parameters
- include System.Boolean = true
public VisioPageImageExportBuilder IncludeText(Boolean include = true) #Returns:
VisioPageImageExportBuilderIncludes or excludes shape and connector text.
Parameters
- include System.Boolean = true
Inherited Methods
public VisioPageImageExportBuilder As(OfficeImageExportFormat format) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public VisioPageImageExportBuilder AsJpeg() #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioPageImageExportBuilder AsPng() #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioPageImageExportBuilder AsSvg() #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioPageImageExportBuilder AsTiff() #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioPageImageExportBuilder AsWebp() #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioPageImageExportBuilder AtDpi(Double dpi) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
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 VisioPageImageExportBuilder ForPreview() #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisioPageImageExportBuilder ForPrint(Double dpi = 300) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public VisioPageImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public VisioPageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
public OfficeImageExportResult Save(Stream stream) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
- cancellationToken CancellationToken = null
public VisioPageImageExportBuilder WithBackground(String color) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public VisioPageImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public VisioPageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public VisioPageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public VisioPageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public VisioPageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public VisioPageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public VisioPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public VisioPageImageExportBuilder WithScale(Double scale) #Returns:
VisioPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double