API Reference
Class
ExcelWorkbookImageExportBuilder
Fluent image-export builder for selected worksheets in an Excel workbook.
Inheritance
- OfficeImageExportBatchBuilder<ExcelWorkbookImageExportBuilder, ExcelWorkbookImageExportOptions>
- ExcelWorkbookImageExportBuilder
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 ExcelDocument.ToImages
- Method ExcelDocument.ToImages
- Method ExcelWorkbookImageExportBuilder.As
- Method ExcelWorkbookImageExportBuilder.AsJpeg
- Method ExcelWorkbookImageExportBuilder.AsPng
- Method ExcelWorkbookImageExportBuilder.AsSvg
- Method ExcelWorkbookImageExportBuilder.AsTiff
- Method ExcelWorkbookImageExportBuilder.AsWebp
- Method ExcelWorkbookImageExportBuilder.AtDpi
- Method ExcelWorkbookImageExportBuilder.ForPreview
- Method ExcelWorkbookImageExportBuilder.ForPrint
- Method ExcelWorkbookImageExportBuilder.ForSheets
- Method ExcelWorkbookImageExportBuilder.IncludeCharts
- Method ExcelWorkbookImageExportBuilder.IncludeConditionalFormatting
- Method ExcelWorkbookImageExportBuilder.IncludeDrawingObjects
- Method ExcelWorkbookImageExportBuilder.IncludeHidden
- Method ExcelWorkbookImageExportBuilder.IncludeHiddenSheets
- Method ExcelWorkbookImageExportBuilder.IncludeImages
- Method ExcelWorkbookImageExportBuilder.OnFileConflict
- Method ExcelWorkbookImageExportBuilder.OnRasterOverflow
- Method ExcelWorkbookImageExportBuilder.ShowComments
- Method ExcelWorkbookImageExportBuilder.SplitByManualPageBreaks
- Method ExcelWorkbookImageExportBuilder.UsePrintAreas
- Method ExcelWorkbookImageExportBuilder.WithBackground
- Method ExcelWorkbookImageExportBuilder.WithBatchLimits
- Method ExcelWorkbookImageExportBuilder.WithConditionalFormattingDate
- Method ExcelWorkbookImageExportBuilder.WithFont
- Method ExcelWorkbookImageExportBuilder.WithFonts
- Method ExcelWorkbookImageExportBuilder.WithGridlines
- Method ExcelWorkbookImageExportBuilder.WithImageCodec
- Method ExcelWorkbookImageExportBuilder.WithMaximumConcurrency
- Method ExcelWorkbookImageExportBuilder.WithMaximumRasterPixels
- Method ExcelWorkbookImageExportBuilder.WithoutGridlines
- Method ExcelWorkbookImageExportBuilder.WithPolicy
- Method ExcelWorkbookImageExportBuilder.WithProgress
- Method ExcelWorkbookImageExportBuilder.WithRasterEncoding
- Method ExcelWorkbookImageExportBuilder.WithScale
Methods
ForSheets 2 overloads
public ExcelWorkbookImageExportBuilder ForSheets(IEnumerable<String> sheetNames) #Returns:
ExcelWorkbookImageExportBuilderExports only the named worksheets.
Parameters
- sheetNames System.String[]
ForSheets(System.Collections.Generic.IEnumerable{System.String} sheetNames) #Exports only the named worksheets.
Parameters
- sheetNames System.Collections.Generic.IEnumerable{System.String}
public ExcelWorkbookImageExportBuilder IncludeCharts(Boolean include = true) #Returns:
ExcelWorkbookImageExportBuilderIncludes or excludes worksheet charts.
Parameters
- include System.Boolean = true
public ExcelWorkbookImageExportBuilder IncludeConditionalFormatting(Boolean include = true) #Returns:
ExcelWorkbookImageExportBuilderIncludes or excludes supported conditional-formatting visuals.
Parameters
- include System.Boolean = true
public ExcelWorkbookImageExportBuilder IncludeDrawingObjects(Boolean include = true) #Returns:
ExcelWorkbookImageExportBuilderIncludes or excludes supported drawing objects.
Parameters
- include System.Boolean = true
public ExcelWorkbookImageExportBuilder IncludeImages(Boolean include = true) #Returns:
ExcelWorkbookImageExportBuilderIncludes or excludes worksheet images.
Parameters
- include System.Boolean = true
public ExcelWorkbookImageExportBuilder ShowComments(Boolean show = true) #Returns:
ExcelWorkbookImageExportBuilderEnables or disables visible cell comment bodies.
Parameters
- show System.Boolean = true
public ExcelWorkbookImageExportBuilder SplitByManualPageBreaks(Boolean split = true) #Returns:
ExcelWorkbookImageExportBuilderSplits worksheet exports by manual page breaks.
Parameters
- split System.Boolean = true
public ExcelWorkbookImageExportBuilder UsePrintAreas(Boolean use = true) #Returns:
ExcelWorkbookImageExportBuilderUses each worksheet's print area when one is configured.
Parameters
- use System.Boolean = true
public ExcelWorkbookImageExportBuilder WithConditionalFormattingDate(DateTime date) #Returns:
ExcelWorkbookImageExportBuilderSets the date used to evaluate relative conditional-formatting rules.
Parameters
- date System.DateTime
public ExcelWorkbookImageExportBuilder WithGridlines(Boolean show = true) #Returns:
ExcelWorkbookImageExportBuilderEnables or disables worksheet gridline rendering.
Parameters
- show System.Boolean = true
public ExcelWorkbookImageExportBuilder WithoutGridlines() #Returns:
ExcelWorkbookImageExportBuilderDisables worksheet gridline rendering.
Inherited Methods
public ExcelWorkbookImageExportBuilder As(OfficeImageExportFormat format) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public ExcelWorkbookImageExportBuilder AsJpeg() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AsPng() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AsSvg() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AsTiff() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AsWebp() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AtDpi(Double dpi) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
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 ExcelWorkbookImageExportBuilder ForPreview() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder ForPrint(Double dpi = 300) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public ExcelWorkbookImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public ExcelWorkbookImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
ExcelWorkbookImageExportBuilderInherited 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
public ExcelWorkbookImageExportBuilder WithBackground(String color) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public ExcelWorkbookImageExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public ExcelWorkbookImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public ExcelWorkbookImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public ExcelWorkbookImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public ExcelWorkbookImageExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public ExcelWorkbookImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public ExcelWorkbookImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public ExcelWorkbookImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public ExcelWorkbookImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public ExcelWorkbookImageExportBuilder WithScale(Double scale) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double