RenderPageToDeviceContext Method

Draw a PDF page to a Windows GDI+ device context.

The PdfXpress event PageRendering is raised periodically while drawing.

The PdfXpress event PageRendered is raised upon successful completion.

Syntax

public void RenderPageToDeviceContext( 
   int pageNumber,
   IDeviceContext deviceContext,
   RenderDcOptions options
)

public: void RenderPageToDeviceContext( 
   int pageNumber,
   IDeviceContext* deviceContext,
   RenderDcOptions* options
)

public:
void RenderPageToDeviceContext( 
   int pageNumber,
   IDeviceContext^ deviceContext,
   RenderDcOptions^ options
)

'Declaration
 
Public Sub RenderPageToDeviceContext( _
   ByVal pageNumber As Integer, _
   ByVal deviceContext As IDeviceContext, _
   ByVal options As RenderDcOptions _
)

'Usage
 
Dim instance As Document
Dim pageNumber As Integer
Dim deviceContext As IDeviceContext
Dim options As RenderDcOptions
 
instance.RenderPageToDeviceContext(pageNumber, deviceContext, options)

Parameters

pageNumber: An integer value which represents the existing page number in the PDF document.
deviceContext: The Windows GDI+ device context to draw graphics.
options: Options to customize the draw operation.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if deviceContext is null. Thrown if options is null.
System.ArgumentOutOfRangeException	Thrown if pageNumber is outside the range [ 0 , Document.PageCount ). Thrown if options.ResolutionX is negative. Thrown if options.ResolutionY is negative.
System.ComponentModel.InvalidEnumArgumentException	Thrown if options.ForDeviceTechnology is not an enumerated value.
PdfXpressLicensingException	Thrown if this feature is unavailable for the current license edition.
PdfXpressNotIntializedException	Thrown if invoked before PdfXpress is initialized.
PdfXpressLibraryException	This exception occurs in the underlying PDF library.
PdfXpressException	This exception occurs in the main PDF library.

Remarks

The PdfXpress event PageRendering is raised periodically while drawing.

The PdfXpress event PageRendered is raised upon successful completion.

Copy protected rendering functionality is to be used only for viewing of copy protected PDF documents. This functionality should not be used to violate or bypass PDF file security measures which prevent copying or editing the PDF documents.

Reference

Document Class
Document Members
PageCount Property
RenderDcOptions Class
PageRendered Event
PageRendering Event