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 ExcelWorkbookImageExportBuilder.As
- Method ExcelWorkbookImageExportBuilder.AsPng
- Method ExcelWorkbookImageExportBuilder.AsSvg
- Method ExcelWorkbookImageExportBuilder.AtScale
- Method ExcelWorkbookImageExportBuilder.ForHighResolution
- Method ExcelWorkbookImageExportBuilder.ForPreview
- Method ExcelWorkbookImageExportBuilder.ForSheets
- Method ExcelWorkbookImageExportBuilder.HighResolution
- Method ExcelWorkbookImageExportBuilder.IncludeCharts
- Method ExcelWorkbookImageExportBuilder.IncludeConditionalFormatting
- Method ExcelWorkbookImageExportBuilder.IncludeDrawingObjects
- Method ExcelWorkbookImageExportBuilder.IncludeHidden
- Method ExcelWorkbookImageExportBuilder.IncludeHiddenSheets
- Method ExcelWorkbookImageExportBuilder.IncludeImages
- Method ExcelWorkbookImageExportBuilder.OnBackground
- Method ExcelWorkbookImageExportBuilder.OnTransparentBackground
- Method ExcelWorkbookImageExportBuilder.OnWhiteBackground
- Method ExcelWorkbookImageExportBuilder.Preview
- Method ExcelWorkbookImageExportBuilder.ShowComments
- Method ExcelWorkbookImageExportBuilder.SplitByManualPageBreaks
- Method ExcelWorkbookImageExportBuilder.TransparentBackground
- Method ExcelWorkbookImageExportBuilder.UsePrintAreas
- Method ExcelWorkbookImageExportBuilder.WhiteBackground
- Method ExcelWorkbookImageExportBuilder.WithBackground
- Method ExcelWorkbookImageExportBuilder.WithConditionalFormattingDate
- Method ExcelWorkbookImageExportBuilder.WithGridlines
- Method ExcelWorkbookImageExportBuilder.WithoutGridlines
- 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 AsPng() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AsSvg() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder AtScale(Double scale) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale 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 IReadOnlyList<OfficeImageExportResult> ExportPng() #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public IReadOnlyList<OfficeImageExportResult> ExportSvg() #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder ForHighResolution() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder ForPreview() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder HighResolution() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder OnBackground(String color) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public ExcelWorkbookImageExportBuilder OnTransparentBackground() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder OnWhiteBackground() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder Preview() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public IReadOnlyList<OfficeImageExportResult> SaveAsPng(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public IReadOnlyList<OfficeImageExportResult> SaveAsSvg(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public IReadOnlyList<OfficeImageExportResult> SavePng(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public IReadOnlyList<OfficeImageExportResult> SaveSvg(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public IReadOnlyList<OfficeImageExportResult> SaveTo(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public ExcelWorkbookImageExportBuilder TransparentBackground() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder WhiteBackground() #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public ExcelWorkbookImageExportBuilder WithBackground(String color) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public ExcelWorkbookImageExportBuilder WithScale(Double scale) #Returns:
ExcelWorkbookImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double