PdfPage PdfPage PdfPage PdfPage Class

Definition

Represents a single page in a Portable Document Format (PDF) document.

public : sealed class PdfPage : IPdfPage, IClosablepublic sealed class PdfPage : IPdfPage, IDisposablePublic NotInheritable Class PdfPage Implements IPdfPage, IDisposable// 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)

Properties

Dimensions Dimensions Dimensions Dimensions

Gets the group of dimension properties for a single page in a Portable Document Format (PDF) document.

public : PdfPageDimensions Dimensions { get; }public PdfPageDimensions Dimensions { get; }Public ReadOnly Property Dimensions As PdfPageDimensions// You can use this property in JavaScript.
Value
PdfPageDimensions PdfPageDimensions PdfPageDimensions PdfPageDimensions

The group of page dimension properties.

Index Index Index Index

Gets the relative position of the Portable Document Format (PDF) page within its parent Portable Document Format (PDF) document.

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

The position of the Portable Document Format (PDF) page relative to its parent Portable Document Format (PDF) document.

Remarks

The first page of a Portable Document Format (PDF) document is index 0 (zero).

PreferredZoom PreferredZoom PreferredZoom PreferredZoom

Gets the Portable Document Format (PDF) page's preferred magnification factor.

public : float PreferredZoom { get; }public float PreferredZoom { get; }Public ReadOnly Property PreferredZoom As float// You can use this property in JavaScript.
Value
float float float float

The magnification scaling factor to display or print the Portable Document Format (PDF) page.

Rotation Rotation Rotation Rotation

Gets the number of degrees that the Portable Document Format (PDF) page will be rotated when it's displayed or printed.

public : PdfPageRotation Rotation { get; }public PdfPageRotation Rotation { get; }Public ReadOnly Property Rotation As PdfPageRotation// You can use this property in JavaScript.
Value
PdfPageRotation PdfPageRotation PdfPageRotation PdfPageRotation

The number of degrees to rotate the Portable Document Format (PDF) page, expressed as one of the enumeration values.

Remarks

Degrees are expressed relative to a clockwise rotation. Degrees are expressed in multiples of 90.

Size Size Size Size

Gets the Portable Document Format (PDF) page's size based on its related CropBox, MediaBox, and Rotation property values.

public : Size Size { get; }public Size Size { get; }Public ReadOnly Property Size As Size// You can use this property in JavaScript.
Value
Size Size Size Size

The Portable Document Format (PDF) page's computed size.

Methods

Close() Close() Close() Close()

Releases all resources associated with the Portable Document Format (PDF) page.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

PreparePageAsync() PreparePageAsync() PreparePageAsync() PreparePageAsync()

Begins building the Portable Document Format (PDF) page. After this method finishes, the Portable Document Format (PDF) page is completely built.

public : IAsyncAction PreparePageAsync()public IAsyncAction PreparePageAsync()Public Function PreparePageAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

Represents the fully-built Portable Document Format (PDF) page.

RenderToStreamAsync(IRandomAccessStream) RenderToStreamAsync(IRandomAccessStream) RenderToStreamAsync(IRandomAccessStream) RenderToStreamAsync(IRandomAccessStream)

Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents, as an asynchronous action. This asynchronous action can be used to create an image of the Portable Document Format (PDF) page.

public : IAsyncAction RenderToStreamAsync(IRandomAccessStream outputStream)public IAsyncAction RenderToStreamAsync(IRandomAccessStream outputStream)Public Function RenderToStreamAsync(outputStream As IRandomAccessStream) As IAsyncAction// You can use this method in JavaScript.
Parameters
outputStream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

The stream of data, which represents a Portable Document Format (PDF) page's content.

Returns
See Also

RenderToStreamAsync(IRandomAccessStream, PdfPageRenderOptions) RenderToStreamAsync(IRandomAccessStream, PdfPageRenderOptions) RenderToStreamAsync(IRandomAccessStream, PdfPageRenderOptions) RenderToStreamAsync(IRandomAccessStream, PdfPageRenderOptions)

Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an asynchronous action. This asynchronous action can be used to create a customized display image of the Portable Document Format (PDF) page.

public : IAsyncAction RenderToStreamAsync(IRandomAccessStream outputStream, PdfPageRenderOptions options)public IAsyncAction RenderToStreamAsync(IRandomAccessStream outputStream, PdfPageRenderOptions options)Public Function RenderToStreamAsync(outputStream As IRandomAccessStream, options As PdfPageRenderOptions) As IAsyncAction// You can use this method in JavaScript.
Parameters
outputStream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

The stream of data, which represents a Portable Document Format (PDF) page's contents.

options
PdfPageRenderOptions PdfPageRenderOptions PdfPageRenderOptions PdfPageRenderOptions

The requested set of display settings to apply to the display image that is output based on the Portable Document Format (PDF) page.

Returns
See Also

See Also