Class ImageRenderOptions

Namespace

DocWright.Renderers.Imaging

Assembly

DocWright.Renderers.Imaging.dll

Options for rasterizing a laid-out document.

public sealed class ImageRenderOptions

Inheritance

object

ImageRenderOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

These live on the renderer rather than on RenderOptions because that bag is shared with the PDF renderer and the core seams do not widen for one format's needs. Page selection, strict mode and resource limits still come from RenderOptions; everything raster-specific is here.

Constructors

ImageRenderOptions()

Fields

DefaultDpi

The default output resolution, matching the visual harness and typical screen output.

Properties

Background

Gets or sets the page background. Defaults to white.

Dpi

Gets or sets the output resolution in dots per inch. Defaults to DefaultDpi.

Fit

Gets or sets how the page is fitted into Width and Height. Defaults to Contain.

Format

Gets or sets the output format. Defaults to Png.

Height

Gets or sets the target output height in pixels, or 0 for whatever Dpi produces. Defaults to 0.

JpegQuality

Gets or sets the JPEG quality in 1..100. Ignored for PNG. Defaults to 85.

MaxHeight

Gets or sets an upper bound on the output height in pixels, or 0 for none. Defaults to 0.

MaxWidth

Gets or sets an upper bound on the output width in pixels, or 0 for none. Defaults to 0.

PageEncoded

Gets or sets a callback invoked after each page is encoded, receiving the one-based page number and the encoded bytes.

PageStreamFactory

Gets or sets a factory supplying the output stream for each rendered page.

ScalePercent

Gets or sets a uniform scale as a percentage of natural size. Defaults to 100.

Width

Gets or sets the target output width in pixels, or 0 for whatever Dpi produces. Defaults to 0.