API Reference

Class

ExcelWorksheetImageExportBuilder

Edit on GitHub

Namespace OfficeIMO.Excel

Assembly OfficeIMO.Excel

Source OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:97

Base OfficeImageExportBuilder<ExcelWorksheetImageExportBuilder, ExcelWorksheetImageExportOptions>

Modifiers sealed

Fluent image-export builder for an Excel worksheet.

Inheritance

OfficeImageExportBuilder<ExcelWorksheetImageExportBuilder, ExcelWorksheetImageExportOptions>
ExcelWorksheetImageExportBuilder

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

Method ExcelSheet.ToImage
Method ExcelSheet.ToImage
Method ExcelWorksheetImageExportBuilder.As
Method ExcelWorksheetImageExportBuilder.AsJpeg
Method ExcelWorksheetImageExportBuilder.AsPng
Method ExcelWorksheetImageExportBuilder.AsSvg
Method ExcelWorksheetImageExportBuilder.AsTiff
Method ExcelWorksheetImageExportBuilder.AsWebp
Method ExcelWorksheetImageExportBuilder.AtDpi
Method ExcelWorksheetImageExportBuilder.ConfigureOptions
Method ExcelWorksheetImageExportBuilder.FitWithin
Method ExcelWorksheetImageExportBuilder.FitWithinHeight
Method ExcelWorksheetImageExportBuilder.FitWithinWidth
Method ExcelWorksheetImageExportBuilder.ForPreview
Method ExcelWorksheetImageExportBuilder.ForPrint
Method ExcelWorksheetImageExportBuilder.ForRange
Method ExcelWorksheetImageExportBuilder.IncludeCharts
Method ExcelWorksheetImageExportBuilder.IncludeConditionalFormatting
Method ExcelWorksheetImageExportBuilder.IncludeDrawingObjects
Method ExcelWorksheetImageExportBuilder.IncludeHidden
Method ExcelWorksheetImageExportBuilder.IncludeImages
Method ExcelWorksheetImageExportBuilder.OnFileConflict
Method ExcelWorksheetImageExportBuilder.OnRasterOverflow
Method ExcelWorksheetImageExportBuilder.ShowComments
Method ExcelWorksheetImageExportBuilder.ShowHyperlinkHints
Method ExcelWorksheetImageExportBuilder.UsePrintArea
Method ExcelWorksheetImageExportBuilder.WithBackground
Method ExcelWorksheetImageExportBuilder.WithBackground
Method ExcelWorksheetImageExportBuilder.WithFont
Method ExcelWorksheetImageExportBuilder.WithFonts
Method ExcelWorksheetImageExportBuilder.WithGridlines
Method ExcelWorksheetImageExportBuilder.WithImageCodec
Method ExcelWorksheetImageExportBuilder.WithMaximumRasterPixels
Method ExcelWorksheetImageExportBuilder.WithoutGridlines
Method ExcelWorksheetImageExportBuilder.WithoutSizeLimit
Method ExcelWorksheetImageExportBuilder.WithPolicy
Method ExcelWorksheetImageExportBuilder.WithProgress
Method ExcelWorksheetImageExportBuilder.WithRasterEncoding
Method ExcelWorksheetImageExportBuilder.WithRenderTimeout
Method ExcelWorksheetImageExportBuilder.WithScale
Method ExcelWorksheetImageExportBuilder.WithTextShaping

Methods

public ExcelWorksheetImageExportBuilder ForRange(String range) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:97

Returns: ExcelWorksheetImageExportBuilder

Exports an explicit A1 range instead of the worksheet used range.

Parameters

range System.String requiredposition: 0

public ExcelWorksheetImageExportBuilder IncludeCharts(Boolean include = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:127

Returns: ExcelWorksheetImageExportBuilder

Includes or excludes worksheet charts.

Parameters

include System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder IncludeConditionalFormatting(Boolean include = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:133

Returns: ExcelWorksheetImageExportBuilder

Includes or excludes supported conditional-formatting visuals.

Parameters

include System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder IncludeDrawingObjects(Boolean include = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:130

Returns: ExcelWorksheetImageExportBuilder

Includes or excludes supported drawing objects.

Parameters

include System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder IncludeHidden(Boolean include = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:121

Returns: ExcelWorksheetImageExportBuilder

Includes or excludes hidden rows and columns.

Parameters

include System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder IncludeImages(Boolean include = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:124

Returns: ExcelWorksheetImageExportBuilder

Includes or excludes worksheet images.

Parameters

include System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder ShowComments(Boolean show = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:136

Returns: ExcelWorksheetImageExportBuilder

Enables or disables visible cell comment bodies.

Parameters

show System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder ShowHyperlinkHints(Boolean show = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:139

Returns: ExcelWorksheetImageExportBuilder

Enables or disables automatic hyperlink styling hints.

Parameters

show System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder UsePrintArea(Boolean use = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:107

Returns: ExcelWorksheetImageExportBuilder

Uses the worksheet print area when one is configured.

Parameters

use System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder WithGridlines(Boolean show = true) #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:113

Returns: ExcelWorksheetImageExportBuilder

Enables or disables worksheet gridline rendering.

Parameters

show System.Boolean = true optionalposition: 0

public ExcelWorksheetImageExportBuilder WithoutGridlines() #

OfficeIMO.Excel/Imaging/ExcelImageExportBuilder.cs:118

Returns: ExcelWorksheetImageExportBuilder

Disables worksheet gridline rendering.

Inherited Methods

public ExcelWorksheetImageExportBuilder As(OfficeImageExportFormat format) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:298

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public ExcelWorksheetImageExportBuilder AsJpeg() #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:230

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder AsPng() #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:201

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder AsSvg() #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:213

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder AsTiff() #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:243

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder AsWebp() #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:284

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder AtDpi(Double dpi) #

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

dpi Double requiredposition: 0

public ExcelWorksheetImageExportBuilder ConfigureOptions(Action<ExcelWorksheetImageExportOptions> configure) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:153

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

configure Action<ExcelWorksheetImageExportOptions> requiredposition: 0

public override Boolean Equals(Object obj) #

OfficeIMO.Excel/ExcelDocument.CustomDocumentProperties.cs:181

Returns: Boolean

Inherited from Object

Parameters

obj Object requiredposition: 0

Export 2 overloads

public OfficeImageExportResult Export() #

Returns: OfficeImageExportResult

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

public OfficeImageExportResult Export(CancellationToken cancellationToken) #

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:148

Returns: OfficeImageExportResult

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

Parameters

cancellationToken CancellationToken requiredposition: 0

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

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:182

Returns: Task<OfficeImageExportResult>

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

Parameters

cancellationToken CancellationToken = null optionalposition: 0

public ExcelWorksheetImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:377

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0
maximumHeight Int32 requiredposition: 1

public ExcelWorksheetImageExportBuilder FitWithinHeight(Int32 maximumHeight) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:431

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

maximumHeight Int32 requiredposition: 0

public ExcelWorksheetImageExportBuilder FitWithinWidth(Int32 maximumWidth) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:394

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0

public ExcelWorksheetImageExportBuilder ForPreview() #

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder ForPrint(Double dpi = 300) #

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:94

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

dpi Double = 300 optionalposition: 0

public override Int32 GetHashCode() #

OfficeIMO.Excel/ExcelDocument.DataReader.cs:66

Returns: Int32

Inherited from Object

public Type GetType() #

OfficeIMO.Excel/ExcelDocument.CustomDocumentProperties.cs:50

Returns: Type

Inherited from Object

public ExcelWorksheetImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:39

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public ExcelWorksheetImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

OfficeIMO.Excel/ExcelSheet.Images.cs:157

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

behavior OfficeRasterOverflowBehavior requiredposition: 0

Save 2 overloads

public OfficeImageExportResult Save(String path) #

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:303

Returns: OfficeImageExportResult

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

Parameters

path String requiredposition: 0

public OfficeImageExportResult Save(Stream stream) #

Returns: OfficeImageExportResult

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

Parameters

stream Stream requiredposition: 0

SaveAsync 2 overloads

public async Task<OfficeImageExportResult> SaveAsync(String path, CancellationToken cancellationToken = null) #

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:342

Returns: Task<OfficeImageExportResult>

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

Parameters

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

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

Returns: Task<OfficeImageExportResult>

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

Parameters

stream Stream requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public Byte[] ToBytes() #

OfficeIMO.Excel/ExcelSheet.Images.Placement.cs:249

Returns: Byte[]

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

public override String ToString() #

OfficeIMO.Excel/ExcelDocument.CustomDocumentProperties.cs:175

Returns: String

Inherited from Object

WithBackground 2 overloads

public ExcelWorksheetImageExportBuilder WithBackground(OfficeColor color) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:471

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

color OfficeColor requiredposition: 0

public ExcelWorksheetImageExportBuilder WithBackground(String color) #

OfficeIMO.Excel/ExcelSheet.Images.cs:21

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

color String requiredposition: 0

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

OfficeIMO.Excel/ExcelSheet.Images.cs:202

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

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

public ExcelWorksheetImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public ExcelWorksheetImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

OfficeIMO.Excel/ExcelSheet.Images.cs:173

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public ExcelWorksheetImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

OfficeIMO.Excel/ExcelSheet.Images.cs:53

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public ExcelWorksheetImageExportBuilder WithoutSizeLimit() #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:450

Returns: ExcelWorksheetImageExportBuilder

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

public ExcelWorksheetImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

OfficeIMO.Excel/ExcelSheet.Images.cs:234

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public ExcelWorksheetImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

OfficeIMO.Excel/ExcelSheet.Images.cs:238

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public ExcelWorksheetImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

OfficeIMO.Excel/ExcelSheet.Images.cs:36

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public ExcelWorksheetImageExportBuilder WithRenderTimeout(TimeSpan timeout) #

OfficeIMO.Excel/ExcelSheet.Images.cs:73

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

timeout TimeSpan requiredposition: 0

public ExcelWorksheetImageExportBuilder WithScale(Double scale) #

OfficeIMO.Excel/ExcelSheet.Hyperlinks.cs:305

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

scale Double requiredposition: 0

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

OfficeIMO.Excel/ExcelSheet.Images.cs:231

Returns: ExcelWorksheetImageExportBuilder

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

Parameters

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