Class ImageOptions

Options for `TransformType.image` and `TransformType.image_pdf`. Supplying this message with any other transform type fails with `invalid_options_error`.

Inheritance

object

ImageOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Riviera

Assembly: Dropbox.Api.dll

Syntax

public class ImageOptions

Constructors

ImageOptions(uint, uint)

Initializes a new instance of the ImageOptions class.

Declaration

public ImageOptions(uint pageNumber = 1, uint scalePercent = 100)

Parameters

Type	Name	Description
uint	pageNumber	For multi-page sources (PDFs, presentations, documents), the 1-based page to render. Each request renders one page; to render a whole document, issue one request per page. Defaults to the first page when omitted.
uint	scalePercent	Scale the rendered image to this percentage of its natural size. Must be in (0, 100] -- the pipeline does not upscale, so values above 100 are rejected with invalid_options_error. Defaults to 100 (no scaling) when omitted.

Properties

PageNumber

For multi-page sources (PDFs, presentations, documents), the 1-based page to render. Each request renders one page; to render a whole document, issue one request per page. Defaults to the first page when omitted.

Declaration

public uint PageNumber { get; protected set; }

Property Value

Type	Description
uint

ScalePercent

Scale the rendered image to this percentage of its natural size. Must be in (0, 100] -- the pipeline does not upscale, so values above 100 are rejected with `invalid_options_error`. Defaults to 100 (no scaling) when omitted.

Declaration

public uint ScalePercent { get; protected set; }

Property Value

Type	Description
uint