API Reference
Class
ExcelRangeImageExportBuilder
Fluent image-export builder for an Excel range.
Inheritance
- OfficeImageExportBuilder<ExcelRangeImageExportBuilder, ExcelImageExportOptions>
- ExcelRangeImageExportBuilder
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 ExcelRange.ToImage
- Method ExcelRange.ToImage
- Method ExcelRangeImageExportBuilder.As
- Method ExcelRangeImageExportBuilder.AsJpeg
- Method ExcelRangeImageExportBuilder.AsPng
- Method ExcelRangeImageExportBuilder.AsSvg
- Method ExcelRangeImageExportBuilder.AsTiff
- Method ExcelRangeImageExportBuilder.AsWebp
- Method ExcelRangeImageExportBuilder.AtDpi
- Method ExcelRangeImageExportBuilder.ConfigureOptions
- Method ExcelRangeImageExportBuilder.FitWithin
- Method ExcelRangeImageExportBuilder.FitWithinHeight
- Method ExcelRangeImageExportBuilder.FitWithinWidth
- Method ExcelRangeImageExportBuilder.ForPreview
- Method ExcelRangeImageExportBuilder.ForPrint
- Method ExcelRangeImageExportBuilder.IncludeCharts
- Method ExcelRangeImageExportBuilder.IncludeConditionalFormatting
- Method ExcelRangeImageExportBuilder.IncludeDrawingObjects
- Method ExcelRangeImageExportBuilder.IncludeHidden
- Method ExcelRangeImageExportBuilder.IncludeImages
- Method ExcelRangeImageExportBuilder.OnFileConflict
- Method ExcelRangeImageExportBuilder.OnRasterOverflow
- Method ExcelRangeImageExportBuilder.ShowComments
- Method ExcelRangeImageExportBuilder.ShowHyperlinkHints
- Method ExcelRangeImageExportBuilder.WithBackground
- Method ExcelRangeImageExportBuilder.WithBackground
- Method ExcelRangeImageExportBuilder.WithConditionalFormattingDate
- Method ExcelRangeImageExportBuilder.WithFont
- Method ExcelRangeImageExportBuilder.WithFonts
- Method ExcelRangeImageExportBuilder.WithGridlines
- Method ExcelRangeImageExportBuilder.WithImageCodec
- Method ExcelRangeImageExportBuilder.WithMaximumRasterPixels
- Method ExcelRangeImageExportBuilder.WithoutGridlines
- Method ExcelRangeImageExportBuilder.WithoutSizeLimit
- Method ExcelRangeImageExportBuilder.WithPolicy
- Method ExcelRangeImageExportBuilder.WithProgress
- Method ExcelRangeImageExportBuilder.WithRasterEncoding
- Method ExcelRangeImageExportBuilder.WithRenderTimeout
- Method ExcelRangeImageExportBuilder.WithScale
- Method ExcelRangeImageExportBuilder.WithTextShaping
Methods
public ExcelRangeImageExportBuilder IncludeCharts(Boolean include = true) #Returns:
ExcelRangeImageExportBuilderIncludes or excludes worksheet charts.
Parameters
- include System.Boolean = true
public ExcelRangeImageExportBuilder IncludeConditionalFormatting(Boolean include = true) #Returns:
ExcelRangeImageExportBuilderIncludes or excludes supported conditional-formatting visuals.
Parameters
- include System.Boolean = true
public ExcelRangeImageExportBuilder IncludeDrawingObjects(Boolean include = true) #Returns:
ExcelRangeImageExportBuilderIncludes or excludes supported drawing objects.
Parameters
- include System.Boolean = true
public ExcelRangeImageExportBuilder IncludeImages(Boolean include = true) #Returns:
ExcelRangeImageExportBuilderIncludes or excludes worksheet images.
Parameters
- include System.Boolean = true
public ExcelRangeImageExportBuilder ShowComments(Boolean show = true) #Returns:
ExcelRangeImageExportBuilderEnables or disables visible cell comment bodies.
Parameters
- show System.Boolean = true
public ExcelRangeImageExportBuilder ShowHyperlinkHints(Boolean show = true) #Returns:
ExcelRangeImageExportBuilderEnables or disables automatic hyperlink styling hints.
Parameters
- show System.Boolean = true
public ExcelRangeImageExportBuilder WithConditionalFormattingDate(DateTime date) #Returns:
ExcelRangeImageExportBuilderSets the date used to evaluate relative conditional-formatting rules.
Parameters
- date System.DateTime
public ExcelRangeImageExportBuilder WithGridlines(Boolean show = true) #Returns:
ExcelRangeImageExportBuilderEnables or disables worksheet gridline rendering.
Parameters
- show System.Boolean = true
public ExcelRangeImageExportBuilder WithoutGridlines() #Returns:
ExcelRangeImageExportBuilderDisables worksheet gridline rendering.
Inherited Methods
public ExcelRangeImageExportBuilder As(OfficeImageExportFormat format) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public ExcelRangeImageExportBuilder AsJpeg() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder AsPng() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder AsSvg() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder AsTiff() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder AsWebp() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder AtDpi(Double dpi) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public ExcelRangeImageExportBuilder ConfigureOptions(Action<ExcelImageExportOptions> configure) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<ExcelImageExportOptions>
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 ExcelRangeImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public ExcelRangeImageExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public ExcelRangeImageExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public ExcelRangeImageExportBuilder ForPreview() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder ForPrint(Double dpi = 300) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public ExcelRangeImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public ExcelRangeImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
ExcelRangeImageExportBuilderInherited 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 ExcelRangeImageExportBuilder WithBackground(OfficeColor color) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public ExcelRangeImageExportBuilder WithBackground(String color) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public ExcelRangeImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public ExcelRangeImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public ExcelRangeImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public ExcelRangeImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public ExcelRangeImageExportBuilder WithoutSizeLimit() #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelRangeImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public ExcelRangeImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public ExcelRangeImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public ExcelRangeImageExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public ExcelRangeImageExportBuilder WithScale(Double scale) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public ExcelRangeImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
ExcelRangeImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null