API Reference
ExcelImageExportOptions
Options for dependency-free Excel range, worksheet, and workbook image export.
Inheritance
- OfficeImageExportOptions
- ExcelImageExportOptions
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
Accepted by parameters
- Method ExcelChart.ExportImage
- Method ExcelChart.SaveAsJpeg
- Method ExcelChart.SaveAsJpeg
- Method ExcelChart.SaveAsJpegAsync
- Method ExcelChart.SaveAsJpegAsync
- Method ExcelChart.SaveAsPng
- Method ExcelChart.SaveAsPng
- Method ExcelChart.SaveAsPngAsync
- Method ExcelChart.SaveAsPngAsync
- Method ExcelChart.SaveAsSvg
- Method ExcelChart.SaveAsSvg
- Method ExcelChart.SaveAsSvgAsync
- Method ExcelChart.SaveAsSvgAsync
- Method ExcelChart.SaveAsTiff
- Method ExcelChart.SaveAsTiff
- Method ExcelChart.SaveAsTiffAsync
- Method ExcelChart.SaveAsTiffAsync
- Method ExcelChart.SaveAsWebp
- Method ExcelChart.SaveAsWebp
- Method ExcelChart.SaveAsWebpAsync
- Method ExcelChart.SaveAsWebpAsync
- Method ExcelChart.ToImage
- Method ExcelChart.ToJpeg
- Method ExcelChart.ToPng
- Method ExcelChart.ToSvg
- Method ExcelChart.ToTiff
- Method ExcelChart.ToWebp
- Method ExcelChartImageExportBuilder.ConfigureOptions
- Method ExcelRange.CreateVisualSnapshot
- Method ExcelRange.ExportImage
- Method ExcelRange.SaveAsJpeg
- Method ExcelRange.SaveAsJpeg
- Method ExcelRange.SaveAsJpegAsync
- Method ExcelRange.SaveAsJpegAsync
- Method ExcelRange.SaveAsPng
- Method ExcelRange.SaveAsPng
- Method ExcelRange.SaveAsPngAsync
- Method ExcelRange.SaveAsPngAsync
- Method ExcelRange.SaveAsSvg
- Method ExcelRange.SaveAsSvg
- Method ExcelRange.SaveAsSvgAsync
- Method ExcelRange.SaveAsSvgAsync
- Method ExcelRange.SaveAsTiff
- Method ExcelRange.SaveAsTiff
- Method ExcelRange.SaveAsTiffAsync
- Method ExcelRange.SaveAsTiffAsync
- Method ExcelRange.SaveAsWebp
- Method ExcelRange.SaveAsWebp
- Method ExcelRange.SaveAsWebpAsync
- Method ExcelRange.SaveAsWebpAsync
- Method ExcelRange.ToImage
- Method ExcelRange.ToJpeg
- Method ExcelRange.ToPng
- Method ExcelRange.ToSvg
- Method ExcelRange.ToTiff
- Method ExcelRange.ToWebp
- Method ExcelRangeImageExportBuilder.ConfigureOptions
Constructors
public ExcelImageExportOptions() #Methods
public ExcelImageExportOptions Clone() #ExcelImageExportOptionsCreates an independent options snapshot.
Inherited Methods
public OfficeImageExportResult EnsureAccepted(OfficeImageExportResult result) #OfficeImageExportResultParameters
- result OfficeImageExportResult
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
public Double GetEffectiveScale(Double logicalWidth, Double logicalHeight) #DoubleParameters
- logicalWidth Double
- logicalHeight Double
Properties
public OfficeColor GridlineColor { get; set; } #Gridline color used when ShowGridlines is enabled.
public Boolean ShowGridlines { get; set; } #Whether default worksheet gridlines are rendered.
public Boolean IncludeImages { get; set; } #Whether worksheet images should be included.
public Boolean IncludeCharts { get; set; } #Whether worksheet charts should be included when supported.
public Boolean IncludeDrawingObjects { get; set; } #Whether supported worksheet drawing objects, such as simple shapes and text boxes, should be included.
public Boolean IncludeConditionalFormatting { get; set; } #Whether supported conditional formatting visuals should be included.
public Nullable<DateTime> ConditionalFormattingDate { get; set; } #Date used to evaluate relative conditional-formatting time-period rules such as Today, Yesterday, Last7Days, and ThisMonth. When omitted, image export uses the current local date captured during option normalization.
public Boolean ShowHyperlinkHints { get; set; } #Whether cells with hyperlink metadata should get a default blue underline hint when their style does not already make the link visible.
public Boolean ShowCommentBodies { get; set; } #Whether visible cell comment and threaded-comment bodies should be rendered as dependency-free callouts.
public Double DefaultColumnWidthPixels { get; set; } #Default column width in pixels when a column has no explicit width.
public Double DefaultRowHeightPixels { get; set; } #Default row height in pixels when a row has no explicit height.
public Int32 MaximumRenderedCells { get; set; } #Maximum number of worksheet cells materialized for one visual snapshot. This limit is applied before rows, columns, and cells are expanded from drawing-driven ranges.
public Int64 MaximumTotalSourceImageBytes { get; set; } #Maximum aggregate bytes read from embedded worksheet images for one visual snapshot. This is independent from MaximumTotalEncodedBytes, which limits encoded output bytes.
public Int32 MaximumPageBreakImages { get; set; } #Maximum aggregate number of image results that multi-area print ranges and manual row or column page breaks may produce for one worksheet export.
Inherited Properties
public Double Scale { get; set; } #public Nullable<Int32> MaximumOutputWidth { get; set; } #public Nullable<Int32> MaximumOutputHeight { get; set; } #public OfficeColor BackgroundColor { get; set; } #public OfficeRasterEncodingOptions RasterEncoding { get; set; } #public Int64 MaximumRasterPixels { get; set; } #public OfficeRasterOverflowBehavior RasterOverflowBehavior { get; set; } #public IOfficeRasterImageCodec ImageCodec { get; set; } #public Nullable<Double> TargetDpi { get; set; } #public OfficeFontFaceCollection Fonts { get; set; } #public IOfficeTextShapingProvider TextShapingProvider { get; set; } #public String TextShapingLanguage { get; set; } #public OfficeImageExportPolicy Policy { get; set; } #public IProgress<OfficeImageExportProgress> Progress { get; set; } #public Int32 MaximumOutputCount { get; set; } #public Int64 MaximumTotalRasterPixels { get; set; } #public Int64 MaximumTotalEncodedBytes { get; set; } #public TimeSpan RenderTimeout { get; set; } #public Int32 MaximumDegreeOfParallelism { get; set; } #public override Double LogicalUnitsPerInch { get; } #Fields
public const Int32 DefaultMaximumRenderedCells #Default maximum number of worksheet cells materialized for one visual snapshot.
100000public const Int64 DefaultMaximumTotalSourceImageBytes #Default maximum aggregate source-image bytes read for one visual snapshot.
268435456public const Int32 DefaultMaximumPageBreakImages #Default maximum number of images produced from manual page-break splitting.
1000