API Reference

Class

VisioDocumentImageExportBuilder

Edit on GitHub

Namespace OfficeIMO.Visio

Assembly OfficeIMO.Visio

Source OfficeIMO.Visio/VisioImageExportBuilder.cs:34

Base OfficeImageExportBuilder<VisioDocumentImageExportBuilder, VisioImageExportOptions>

Modifiers sealed

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.ForPreview
Method VisioDocumentImageExportBuilder.ForPrint
Method VisioDocumentImageExportBuilder.IncludeText
Method VisioDocumentImageExportBuilder.OnFileConflict
Method VisioDocumentImageExportBuilder.OnRasterOverflow
Method VisioDocumentImageExportBuilder.Page
Method VisioDocumentImageExportBuilder.WithBackground
Method VisioDocumentImageExportBuilder.WithFont
Method VisioDocumentImageExportBuilder.WithFonts
Method VisioDocumentImageExportBuilder.WithImageCodec
Method VisioDocumentImageExportBuilder.WithMaximumRasterPixels
Method VisioDocumentImageExportBuilder.WithPolicy
Method VisioDocumentImageExportBuilder.WithProgress
Method VisioDocumentImageExportBuilder.WithRasterEncoding
Method VisioDocumentImageExportBuilder.WithScale
Method VisioImageExportFluentExtensions.ToImage
Method VisioImageExportFluentExtensions.ToImage

Methods

public VisioDocumentImageExportBuilder IncludeText(Boolean include = true) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:40

Returns: VisioDocumentImageExportBuilder

Includes or excludes shape and connector text.

Parameters

include System.Boolean = true optionalposition: 0

public VisioDocumentImageExportBuilder Page(Int32 pageIndex) #

OfficeIMO.Visio/VisioImageExportBuilder.cs:34

Returns: VisioDocumentImageExportBuilder

Selects the zero-based document page to export.

Parameters

pageIndex System.Int32 requiredposition: 0

Inherited Methods

public VisioDocumentImageExportBuilder As(OfficeImageExportFormat format) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:57

Returns: VisioDocumentImageExportBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public VisioDocumentImageExportBuilder AsJpeg() #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:54

Returns: VisioDocumentImageExportBuilder

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

public VisioDocumentImageExportBuilder AsPng() #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:51

Returns: VisioDocumentImageExportBuilder

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

public VisioDocumentImageExportBuilder AsSvg() #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:51

Returns: VisioDocumentImageExportBuilder

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

public VisioDocumentImageExportBuilder AsTiff() #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:54

Returns: VisioDocumentImageExportBuilder

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

public VisioDocumentImageExportBuilder AsWebp() #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:57

Returns: VisioDocumentImageExportBuilder

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

public VisioDocumentImageExportBuilder AtDpi(Double dpi) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:69

Returns: VisioDocumentImageExportBuilder

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

Parameters

dpi Double requiredposition: 0

public override Boolean Equals(Object obj) #

OfficeIMO.Visio/ShapeData/VisioDataGraphicExtensions.cs:374

Returns: Boolean

Inherited from Object

Parameters

obj Object requiredposition: 0

public OfficeImageExportResult Export(CancellationToken cancellationToken) #

OfficeIMO.Visio/Swimlanes/VisioSwimlaneActivityPlacement.cs:26

Returns: OfficeImageExportResult

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

Parameters

cancellationToken CancellationToken requiredposition: 0

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

OfficeIMO.Visio/Swimlanes/VisioSwimlaneLane.cs:8

Returns: Task<OfficeImageExportResult>

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

Parameters

cancellationToken CancellationToken = null optionalposition: 0

public VisioDocumentImageExportBuilder ForPreview() #

OfficeIMO.Visio/Swimlanes/VisioSwimlaneActivityPlacement.cs:17

Returns: VisioDocumentImageExportBuilder

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

public VisioDocumentImageExportBuilder ForPrint(Double dpi = 300) #

OfficeIMO.Visio/Swimlanes/VisioSwimlaneActivityPlacement.cs:20

Returns: VisioDocumentImageExportBuilder

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

Parameters

dpi Double = 300 optionalposition: 0

public override Int32 GetHashCode() #

OfficeIMO.Visio/ShapeData/VisioDataGraphicExtensions.cs:377

Returns: Int32

Inherited from Object

public Type GetType() #

OfficeIMO.Visio/ShapeData/VisioDataGraphicExtensions.cs:365

Returns: Type

Inherited from Object

public VisioDocumentImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

OfficeIMO.Visio/Swimlanes/VisioSwimlaneActivityPlacement.cs:9

Returns: VisioDocumentImageExportBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public VisioDocumentImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:66

Returns: VisioDocumentImageExportBuilder

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

Parameters

behavior OfficeRasterOverflowBehavior requiredposition: 0

public OfficeImageExportResult Save(Stream stream) #

OfficeIMO.Visio/Swimlanes/VisioSwimlaneLane.cs:25

Returns: OfficeImageExportResult

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

Parameters

path String requiredposition: 0

public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #

OfficeIMO.Visio/Swimlanes/VisioSwimlanePhase.cs:18

Returns: Task<OfficeImageExportResult>

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

Parameters

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

public Byte[] ToBytes() #

OfficeIMO.Visio/Swimlanes/VisioSwimlaneLane.cs:19

Returns: Byte[]

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

public override String ToString() #

OfficeIMO.Visio/ShapeData/VisioDataGraphicExtensions.cs:371

Returns: String

Inherited from Object

public VisioDocumentImageExportBuilder WithBackground(String color) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:63

Returns: VisioDocumentImageExportBuilder

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

Parameters

color OfficeColor requiredposition: 0

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

OfficeIMO.Visio/Styles/VisioTextStyle.cs:71

Returns: VisioDocumentImageExportBuilder

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

Parameters

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

public VisioDocumentImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:71

Returns: VisioDocumentImageExportBuilder

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

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public VisioDocumentImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:69

Returns: VisioDocumentImageExportBuilder

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

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public VisioDocumentImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:66

Returns: VisioDocumentImageExportBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public VisioDocumentImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:75

Returns: VisioDocumentImageExportBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public VisioDocumentImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

Returns: VisioDocumentImageExportBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public VisioDocumentImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:63

Returns: VisioDocumentImageExportBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public VisioDocumentImageExportBuilder WithScale(Double scale) #

OfficeIMO.Visio/Styles/VisioTextStyle.cs:60

Returns: VisioDocumentImageExportBuilder

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

Parameters

scale Double requiredposition: 0