PdfPageRenderOptions PdfPageRenderOptions PdfPageRenderOptions PdfPageRenderOptions Class

Definition

Represents display settings for a single page of a Portable Document Format (PDF) document, such as the page's background color and its encoding type.

public : sealed class PdfPageRenderOptions : IPdfPageRenderOptionspublic sealed class PdfPageRenderOptions : IPdfPageRenderOptionsPublic NotInheritable Class PdfPageRenderOptions Implements IPdfPageRenderOptions// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Constructors

PdfPageRenderOptions() PdfPageRenderOptions() PdfPageRenderOptions() PdfPageRenderOptions()

Creates and initializes a new instance of display settings for a single page of a Portable Document Format (PDF) document.

public : PdfPageRenderOptions()public PdfPageRenderOptions()Public Sub New()// You can use this method in JavaScript.

Properties

BackgroundColor BackgroundColor BackgroundColor BackgroundColor

Gets or sets the Portable Document Format (PDF) page's background color.

public : Color BackgroundColor { get; set; }public Color BackgroundColor { get; set; }Public ReadWrite Property BackgroundColor As Color// You can use this property in JavaScript.
Value
Color Color Color Color

The Portable Document Format (PDF) page's background color.

Remarks

The default background color is White

BitmapEncoderId BitmapEncoderId BitmapEncoderId BitmapEncoderId

Gets or sets the Portable Document Format (PDF) page's encoding type to be used while the page is being converted to a bitmap.

public : PlatForm::Guid BitmapEncoderId { get; set; }public Guid BitmapEncoderId { get; set; }Public ReadWrite Property BitmapEncoderId As Guid// You can use this property in JavaScript.
Value
PlatForm::Guid Guid Guid Guid

A BmpEncoderId value representing the unique identifier of the built-in bitmap encoder.

DestinationHeight DestinationHeight DestinationHeight DestinationHeight

Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs).

public : unsigned int DestinationHeight { get; set; }public uint DestinationHeight { get; set; }Public ReadWrite Property DestinationHeight As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The Portable Document Format (PDF) page's scaling factor relative to the page's destination display height boundary.

Remarks

The value for DestinationHeight is the final size of the rendered page. If DestinationHeight is not specified, the page's aspect ratio is maintained relative to the destination width.

DestinationWidth DestinationWidth DestinationWidth DestinationWidth

Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs).

public : unsigned int DestinationWidth { get; set; }public uint DestinationWidth { get; set; }Public ReadWrite Property DestinationWidth As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The Portable Document Format (PDF) page's scaling factor relative to the page's destination display width boundary.

Remarks

The value for DestinationWidth is the final size of the rendered page. If DestinationWidth is not specified, the page's aspect ratio is maintained relative to the destination height.

IsIgnoringHighContrast IsIgnoringHighContrast IsIgnoringHighContrast IsIgnoringHighContrast

Gets or sets whether the Portable Document Format (PDF) page uses the system's high contrast display setting.

public : PlatForm::Boolean IsIgnoringHighContrast { get; set; }public bool IsIgnoringHighContrast { get; set; }Public ReadWrite Property IsIgnoringHighContrast As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

False to use high contrast; otherwise, true.

SourceRect SourceRect SourceRect SourceRect

Gets or sets a portion of the Portable Document Format (PDF) page to be displayed.

public : Rect SourceRect { get; set; }public Rect SourceRect { get; set; }Public ReadWrite Property SourceRect As Rect// You can use this property in JavaScript.
Value
Rect Rect Rect Rect

The portion of the Portable Document Format (PDF) page to be displayed.