ExcelImageExportOptions
OfficeIMO.Excel
Options for dependency-free Excel range, worksheet, and workbook image export.
Inheritance
- OfficeImageExportOptions
- ExcelImageExportOptions
Usage
Explore 23 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Accepted by parameters 22
- Method ExcelChart.SaveAsImage
- Method ExcelChart.SaveAsImageAsync
- Method ExcelChart.ToImage
- Method ExcelChart.ToImageAsync
- Method ExcelDocument.SaveAsImages
- Method ExcelDocument.SaveAsImagesAsync
- Method ExcelDocument.ToImages
- Method ExcelDocument.ToImagesAsync
- Method ExcelRange.CreateVisualSnapshot
- Method ExcelRange.SaveAsImage
- Method ExcelRange.SaveAsImageAsync
- Method ExcelRange.ToImage
- Method ExcelRange.ToImageAsync
- Method ExcelSheet.CreateVisualSnapshot
- Method ExcelSheet.SaveAsImage
- Method ExcelSheet.SaveAsImageAsync
- Method ExcelSheet.SaveAsImages
- Method ExcelSheet.SaveAsImagesAsync
- Method ExcelSheet.ToImage
- Method ExcelSheet.ToImageAsync
- Method ExcelSheet.ToImages
- Method ExcelSheet.ToImagesAsync
Constructors
public ExcelImageExportOptions() #Methods
public ExcelImageExportOptions Clone() #Creates an independent options snapshot.
Returns
ExcelImageExportOptionsInherited Methods
public OfficeImageExportResult EnsureAccepted(OfficeImageExportResult result) #Parameters
- result OfficeImageExportResult
Returns
OfficeImageExportResultpublic double GetEffectiveScale(double logicalWidth, double logicalHeight) #Parameters
- logicalWidth double
- logicalHeight double
Returns
doubleProperties
public OfficeColor GridlineColor { get; set; } #Gridline color used when ExcelImageExportOptions.ShowGridlines is enabled.
public bool ShowGridlines { get; set; } #Whether default worksheet gridlines are rendered.
public bool IncludeImages { get; set; } #Whether worksheet images should be included.
public bool IncludeCharts { get; set; } #Whether worksheet charts should be included when supported.
public bool IncludeDrawingObjects { get; set; } #Whether supported worksheet drawing objects, such as simple shapes and text boxes, should be included.
public bool IncludeConditionalFormatting { get; set; } #Whether supported conditional formatting visuals should be included.
public 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 bool 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 bool ShowCommentBodies { get; set; } #Whether visible cell comment and threaded-comment bodies should be rendered as dependency-free callouts.
public OfficeLength DefaultColumnWidth { get; set; } #Fallback physical column width used by image layout when no explicit width is stored.
public OfficeLength DefaultRowHeight { get; set; } #Fallback physical row height used by image layout when no explicit height is stored.
public int 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 long MaximumTotalSourceImageBytes { get; set; } #Maximum aggregate bytes read from embedded worksheet images for one visual snapshot. This is independent from OfficeImageExportOptions.MaximumTotalEncodedBytes, which limits encoded output bytes.
public int 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.
public string? Range { get; set; } #Explicit A1 range, or null to render each selected worksheet's used range.
public bool UsePrintArea { get; set; } #Uses configured print-area segments when no explicit range is supplied.
public bool SplitByManualPageBreaks { get; set; } #Splits worksheet batches at manual row and column page breaks. Single-image rendering reports unsplit content.
public IReadOnlyList<string>? SheetNames { get; set; } #Worksheet names to export. Explicitly selected sheets are included regardless of visibility.
Inherited Properties
public OfficeImageExportFormat Format { get; set; } #public OfficePageSelector? PageSelector { get; set; } #public OfficeImageExportFileConflictPolicy FileConflictPolicy { get; set; } #public bool FailOnLoss { get; set; } #public double Scale { get; set; } #public int? MaximumOutputWidth { get; set; } #public int? MaximumOutputHeight { get; set; } #public OfficeColor BackgroundColor { get; set; } #public OfficeRasterEncodingOptions RasterEncoding { get; set; } #public bool SvgTextAsPaths { get; set; } #public long MaximumRasterPixels { get; set; } #public OfficeRasterOverflowBehavior RasterOverflowBehavior { get; set; } #public IOfficeRasterImageCodec? ImageCodec { get; set; } #public 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 int MaximumOutputCount { get; set; } #public long MaximumTotalRasterPixels { get; set; } #public long MaximumTotalEncodedBytes { get; set; } #public TimeSpan RenderTimeout { get; set; } #public int MaximumDegreeOfParallelism { get; set; } #public virtual double LogicalUnitsPerInch { get; } #Fields
public const int DefaultMaximumRenderedCells #Default maximum number of worksheet cells materialized for one visual snapshot.
100000public const long DefaultMaximumTotalSourceImageBytes #Default maximum aggregate source-image bytes read for one visual snapshot.
268435456public const int DefaultMaximumPageBreakImages #Default maximum number of images produced from manual page-break splitting.
1000