API Reference
Class
ExcelWorksheetImageBatchExportBuilder
Fluent batch image export for worksheet print areas and manual page-break segments.
Inheritance
- OfficeImageExportBatchBuilder<ExcelWorksheetImageBatchExportBuilder, ExcelWorksheetImageExportOptions>
- ExcelWorksheetImageBatchExportBuilder
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.ToImages
- Method ExcelSheet.ToImages
- Method ExcelWorksheetImageBatchExportBuilder.As
- Method ExcelWorksheetImageBatchExportBuilder.AsJpeg
- Method ExcelWorksheetImageBatchExportBuilder.AsPng
- Method ExcelWorksheetImageBatchExportBuilder.AsSvg
- Method ExcelWorksheetImageBatchExportBuilder.AsTiff
- Method ExcelWorksheetImageBatchExportBuilder.AsWebp
- Method ExcelWorksheetImageBatchExportBuilder.AtDpi
- Method ExcelWorksheetImageBatchExportBuilder.ConfigureOptions
- Method ExcelWorksheetImageBatchExportBuilder.FitWithin
- Method ExcelWorksheetImageBatchExportBuilder.FitWithinHeight
- Method ExcelWorksheetImageBatchExportBuilder.FitWithinWidth
- Method ExcelWorksheetImageBatchExportBuilder.ForPreview
- Method ExcelWorksheetImageBatchExportBuilder.ForPrint
- Method ExcelWorksheetImageBatchExportBuilder.ForRange
- Method ExcelWorksheetImageBatchExportBuilder.IncludeCharts
- Method ExcelWorksheetImageBatchExportBuilder.IncludeConditionalFormatting
- Method ExcelWorksheetImageBatchExportBuilder.IncludeDrawingObjects
- Method ExcelWorksheetImageBatchExportBuilder.IncludeHidden
- Method ExcelWorksheetImageBatchExportBuilder.IncludeImages
- Method ExcelWorksheetImageBatchExportBuilder.OnFileConflict
- Method ExcelWorksheetImageBatchExportBuilder.OnRasterOverflow
- Method ExcelWorksheetImageBatchExportBuilder.ShowComments
- Method ExcelWorksheetImageBatchExportBuilder.ShowHyperlinkHints
- Method ExcelWorksheetImageBatchExportBuilder.SplitByManualPageBreaks
- Method ExcelWorksheetImageBatchExportBuilder.UsePrintArea
- Method ExcelWorksheetImageBatchExportBuilder.WithBackground
- Method ExcelWorksheetImageBatchExportBuilder.WithBackground
- Method ExcelWorksheetImageBatchExportBuilder.WithBatchLimits
- Method ExcelWorksheetImageBatchExportBuilder.WithFont
- Method ExcelWorksheetImageBatchExportBuilder.WithFonts
- Method ExcelWorksheetImageBatchExportBuilder.WithGridlines
- Method ExcelWorksheetImageBatchExportBuilder.WithImageCodec
- Method ExcelWorksheetImageBatchExportBuilder.WithMaximumConcurrency
- Method ExcelWorksheetImageBatchExportBuilder.WithMaximumRasterPixels
- Method ExcelWorksheetImageBatchExportBuilder.WithoutSizeLimit
- Method ExcelWorksheetImageBatchExportBuilder.WithPolicy
- Method ExcelWorksheetImageBatchExportBuilder.WithProgress
- Method ExcelWorksheetImageBatchExportBuilder.WithQuality
- Method ExcelWorksheetImageBatchExportBuilder.WithRasterEncoding
- Method ExcelWorksheetImageBatchExportBuilder.WithRenderTimeout
- Method ExcelWorksheetImageBatchExportBuilder.WithScale
- Method ExcelWorksheetImageBatchExportBuilder.WithTextShaping
Methods
public ExcelWorksheetImageBatchExportBuilder ForRange(String range) #Returns:
ExcelWorksheetImageBatchExportBuilderExports an explicit A1 range instead of the worksheet used range.
Parameters
- range System.String
public ExcelWorksheetImageBatchExportBuilder IncludeCharts(Boolean include = true) #Returns:
ExcelWorksheetImageBatchExportBuilderIncludes or excludes worksheet charts.
Parameters
- include System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder IncludeConditionalFormatting(Boolean include = true) #Returns:
ExcelWorksheetImageBatchExportBuilderIncludes or excludes supported conditional-formatting visuals.
Parameters
- include System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder IncludeDrawingObjects(Boolean include = true) #Returns:
ExcelWorksheetImageBatchExportBuilderIncludes or excludes supported drawing objects.
Parameters
- include System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder IncludeImages(Boolean include = true) #Returns:
ExcelWorksheetImageBatchExportBuilderIncludes or excludes worksheet images.
Parameters
- include System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder ShowComments(Boolean show = true) #Returns:
ExcelWorksheetImageBatchExportBuilderEnables or disables visible cell comment bodies.
Parameters
- show System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder ShowHyperlinkHints(Boolean show = true) #Returns:
ExcelWorksheetImageBatchExportBuilderEnables or disables automatic hyperlink styling hints.
Parameters
- show System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder SplitByManualPageBreaks(Boolean split = true) #Returns:
ExcelWorksheetImageBatchExportBuilderSplits the selected range at manual row and column page breaks.
Parameters
- split System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder UsePrintArea(Boolean use = true) #Returns:
ExcelWorksheetImageBatchExportBuilderUses every configured worksheet print-area segment.
Parameters
- use System.Boolean = true
public ExcelWorksheetImageBatchExportBuilder WithGridlines(Boolean show = true) #Returns:
ExcelWorksheetImageBatchExportBuilderEnables or disables worksheet gridline rendering.
Parameters
- show System.Boolean = true
Inherited Methods
public ExcelWorksheetImageBatchExportBuilder As(OfficeImageExportFormat format) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public ExcelWorksheetImageBatchExportBuilder AsJpeg() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder AsPng() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder AsSvg() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder AsTiff() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder AsWebp() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder AtDpi(Double dpi) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public ExcelWorksheetImageBatchExportBuilder ConfigureOptions(Action<ExcelWorksheetImageExportOptions> configure) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<ExcelWorksheetImageExportOptions>
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public IReadOnlyList<OfficeImageExportResult> Export() #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public async Task<IReadOnlyList<OfficeImageExportResult>> ExportAsync(CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = null
public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = null) #Returns:
VoidInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportConsumer
- cancellationToken CancellationToken = null
public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = null) #Returns:
TaskInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportAsyncConsumer
- cancellationToken CancellationToken = null
public ExcelWorksheetImageBatchExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public ExcelWorksheetImageBatchExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public ExcelWorksheetImageBatchExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public ExcelWorksheetImageBatchExportBuilder ForPreview() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder ForPrint(Double dpi = 300) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public ExcelWorksheetImageBatchExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public ExcelWorksheetImageBatchExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<IReadOnlyList<OfficeImageExportResult>> SaveAsync(String folderPath, CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = null
public OfficeImageExportBatchSaveResult SaveFiles(String folderPath) #Returns:
OfficeImageExportBatchSaveResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<OfficeImageExportBatchSaveResult> SaveFilesAsync(String folderPath, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportBatchSaveResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = null
WithBackground 2 overloads
public ExcelWorksheetImageBatchExportBuilder WithBackground(OfficeColor color) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public ExcelWorksheetImageBatchExportBuilder WithBackground(String color) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public ExcelWorksheetImageBatchExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public ExcelWorksheetImageBatchExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public ExcelWorksheetImageBatchExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public ExcelWorksheetImageBatchExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public ExcelWorksheetImageBatchExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public ExcelWorksheetImageBatchExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public ExcelWorksheetImageBatchExportBuilder WithoutSizeLimit() #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorksheetImageBatchExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public ExcelWorksheetImageBatchExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public ExcelWorksheetImageBatchExportBuilder WithQuality(OfficeImageExportQuality quality) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- quality OfficeImageExportQuality
public ExcelWorksheetImageBatchExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public ExcelWorksheetImageBatchExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public ExcelWorksheetImageBatchExportBuilder WithScale(Double scale) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public ExcelWorksheetImageBatchExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
ExcelWorksheetImageBatchExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null