API Reference

Class

ExcelImageExportOptions

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Base OfficeImageExportOptions

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.

Accepted by parameters

Constructors

Methods

public ExcelImageExportOptions Clone() #
Returns: ExcelImageExportOptions

Creates an independent options snapshot.

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 IncludeHidden { get; set; } #

Whether hidden rows and columns should be included.

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 Boolean IncludeWorkbookPathInHeaderFooter { get; set; } #

Whether workbook directory paths referenced by header/footer &Z and &[Path] fields may be included in rendered images. The default is false to avoid exposing local or server filesystem paths in exported artifacts.

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.

Fields

public const Int32 DefaultMaximumRenderedCells #

Default maximum number of worksheet cells materialized for one visual snapshot.

Value: 100000
public const Int64 DefaultMaximumTotalSourceImageBytes #

Default maximum aggregate source-image bytes read for one visual snapshot.

Value: 268435456
public const Int32 DefaultMaximumPageBreakImages #

Default maximum number of images produced from manual page-break splitting.

Value: 1000