# OfficeDrawingRasterRenderOptions

Options for rasterizing an Office drawing with an optional image codec.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[IOfficeRasterImageCodec.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L12)

**Modifiers**

sealed

Options for rasterizing an Office drawing with an optional image codec.

## Inheritance

- object
- OfficeDrawingRasterRenderOptions

## Usage

Explore 2 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.

### Accepted by parameters 2

- Method [OfficeDrawingRasterRenderer.Render](/api/core/officeimo-drawing-officedrawingrasterrenderer/#method-render-officeimo-drawing-officedrawing-officeimo-drawing-officedrawingrasterrenderoptions) parameter `options`
- Method [OfficeDrawingRasterRenderer.ToPng](/api/core/officeimo-drawing-officedrawingrasterrenderer/#method-topng-officeimo-drawing-officedrawing-officeimo-drawing-officedrawingrasterrenderoptions) parameter `options`

Filter members 

Show inherited

## Constructors

`public OfficeDrawingRasterRenderOptions()` [#](#constructor-ctor)

[IOfficeRasterImageCodec.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L12)

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public double Scale { get; set; }` [#](#property-scale)

[IOfficeRasterImageCodec.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L12)

Output scale. Defaults to 1.

`public OfficeColor? Background { get; set; }` [#](#property-background)

[IOfficeRasterImageCodec.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L14)

Optional canvas background.

`public IOfficeRasterImageCodec? ImageCodec { get; set; }` [#](#property-imagecodec)

[IOfficeRasterImageCodec.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L16)

Optional decoder for formats not handled by the dependency-free core.

`public bool ThrowOnImageDecodeFailure { get; set; }` [#](#property-throwonimagedecodefailure)

[IOfficeRasterImageCodec.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L18)

Throws when an image cannot be decoded or exceeds the raster limit, instead of omitting it.

`public IOfficeTextShapingProvider? TextShapingProvider { get; set; }` [#](#property-textshapingprovider)

[IOfficeRasterImageCodec.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L20)

Optional host text shaper used for complex-script glyph positioning.

`public string? TextShapingLanguage { get; set; }` [#](#property-textshapinglanguage)

[IOfficeRasterImageCodec.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L22)

Optional BCP 47 language hint passed to the text shaper.

`public ICollection<OfficeImageExportDiagnostic>? DiagnosticSink { get; set; }` [#](#property-diagnosticsink)

[IOfficeRasterImageCodec.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L24)

Optional sink for fidelity diagnostics discovered while rasterizing the drawing.

`public string? DiagnosticSource { get; set; }` [#](#property-diagnosticsource)

[IOfficeRasterImageCodec.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L26)

Optional source label attached to rasterization diagnostics.

`public long MaximumRasterPixels { get; set; }` [#](#property-maximumrasterpixels)

[IOfficeRasterImageCodec.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L28)

Maximum pixels allowed for the output and every nested raster surface.

`public long MaximumClipEdgeChecks { get; set; }` [#](#property-maximumclipedgechecks)

[IOfficeRasterImageCodec.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L30)

Maximum polygon edge checks while painting through non-antialiased clips on one raster canvas.

`public CancellationToken CancellationToken { get; set; }` [#](#property-cancellationtoken)

[IOfficeRasterImageCodec.cs:32](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/IOfficeRasterImageCodec.cs#L32)

Cancellation observed between drawing elements and nested render stages.

<!-- PowerForge markdown artifact sha256:3E2CB8CDFF7B7D79DAB6EB3D8A4790DD7D53C6C617A9793E77DB1A2E589C27C7 -->
