PdfPage Class

Represents a PDF page inside document.

Inheritance Hierarchy

System.Object
Patagames.Pdf.Net.PdfPage

Namespace: Patagames.Pdf.Net
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.94.2704

Syntax

C++

JavaScript

Copy

public class PdfPage : IDisposable

Public Class PdfPage
	Implements IDisposable

public ref class PdfPage : IDisposable

type PdfPage = 
    class
        interface IDisposable
    end

public class PdfPage implements IDisposable

Patagames.Pdf.Net.PdfPage = function();

Type.createClass(
	'Patagames.Pdf.Net.PdfPage',
	null,
	IDisposable);

The PdfPage type exposes the following members.

Properties

	Name	Description
	AdditionalActions	Gets or sets the additional-actions defining actions to be performed when the page is opened or closed.
	Annots	Gets annotations associated with the page
	ArtBox	Gets or sets ArtBox of the page.
	BleedBox	Gets or sets BleedBox of the page.
	CropBox	Gets or sets CropBox of the page.
	Dictionary	Gets the page's dictionary
	Document	Gets the PDF document associated with the current page.
	Handle	Gets the Pdfium SDK handle that the page is bound to
	Height	Gets page height (excluding non-displayable area) measured in points.One point is 1/72 inch (around 0.3528 mm)
	IsAvailable	Gets a value that represents that whether the content of the current PDF page is available.
	IsDisposed	Gets a value indicating whether the object has been disposed of. Field Value true if the page has been disposed of; otherwise, false.
	IsLoaded	Gets a value indicating whether the page has been loaded.
	IsParsed	Gets a value indicating whether the page content has been parsed.
	IsTransparency	Gets a value that represents that whether the content of the current PDF page contains transparency.
	Links	Gets the collection of PDF links found in the current page.
	MediaBox	Gets or sets MediaBox of the page.
	OriginalRotation	Gets the rotation angle of the page in a saved document.
	PageIndex	Gets the index of the page in the document.
	PageObjects	Gets the collection of PDF page objects found in the current page.
	Rotation	Gets or sets the page rotation.
	Tag	Gets or sets the object that contains data about the page.
	Text	Getscurrent instance of PdfText class that represents information about all characters in a page.
	TrimBox	Gets or sets TrimBox of the page.
	Width	Gets page width (excluding non-displayable area) measured in points.One point is 1/72 inch (around 0.3528 mm)

Top

Methods

	Name	Description
	CancelProgressiveRender	Release the resource allocate during page rendering. Need to be called after finishing rendering or cancel the rendering.
	ContinueProgressiveLoad	Continue loading a PDF page.
	ContinueProgressiveRender	Continue rendering a PDF page.
	CreateAnnotations	Creates an annotation collection for the page.
	DeviceToPage(Int32, Int32, Int32, Int32, PageRotate, Int32, Int32)	Convert the screen coordinate of a point to page coordinate.
	DeviceToPage(Int32, Int32, Int32, Int32, PageRotate, Int32, Int32, Double, Double)	Convert the screen coordinate of a point to page coordinate.
	Dispose()	Dispose PDFPage object.
	Dispose(Boolean)	Releases all resources used by the PdfPage object.
	DoPageAAction	This method is required for performing the page object's additional-action when opened or closed.
	Finalize	Finalize object (Overrides Object.Finalize())
	FlattenPage	Flat a pdf page, annotations or form fields will become part of the page contents.
	FromHandle	Creates new instance of PdfPage class from page's hadle.
	GenerateContent	Generate PDF Page content.
	GetControlAtPoint	Get the field's widget at specified position.
	GetFormFieldAtPoint	Check the form field position by point.
	InsertClipPath	Clip the page content, the page content that outside the clipping region become invisible.
	OnDisposed	Raises the Disposed event.
	OnKeyDown	You can call this member function when a key is pressed.
	OnKeyUp	You can call this member function when a key is released.
	OnLButtonDown	You can call this member function when the user presses the left mouse button.
	OnLButtonUp	You can call this member function when the user releases the left mouse button.
	OnLoaded	Raises the Loaded event.
	OnMouseMove	You can call this member function when the mouse cursor moves.
	OnProgressiveRender	Raises the ProgressiveRender event.
	PageToDevice	Convert the page coordinate of a point to screen coordinate
	ReloadPage	Dispose and reload this page.
	Render(IntPtr, Int32, Int32, Int32, Int32, PageRotate, RenderFlags)	Render contents in a page to the device context specified by a coordinate pair, a width, and a height.
	Render(PdfBitmap, Int32, Int32, Int32, Int32, PageRotate, RenderFlags)	Render contents in a page to a device-independent bitmap specified by a coordinate pair, a width, and a height.
	RenderEx	Render contents in a page to a device-independent bitmap specified by a coordinate pair, a width, and a height.
	RenderForms	Render FormFeilds on a page to a device independent bitmap.
	StartProgressiveLoad	Start to load a page inside the document.
	StartProgressiveRender	Start to render page contents to a device independent bitmap progressively specified by a coordinate pair, a width, and a height.
	TransformAnnots	Transform (scale, rotate, shear, move) all annots in a page.
	TransformWithClip	Transform the whole page with a specified matrix, then clip the page content region.

Top

Events

	Name	Description
	Disposed	This event is triggered when the page is unloaded from the memory.
	Loaded	This event is triggered when the page is loaded into memory.
	ProgressiveRender	SDK fire this event during rendering process initiated by {0} Overload method.

Top

Extension Methods

	Name	Description
	DeviceToPageEx	Convert the screen coordinate of a point to page coordinate. (Defined by PdfPageExtension)
	PageToDeviceEx	Convert the page coordinate of a point to screen coordinate (Defined by PdfPageExtension)
	Render	Render contents in a page to a drawing surface specified by a Rectangle structure. (Defined by PdfPageExtension)
	Render	Render contents in a page to the device context specified by a Rectangle structure. (Defined by PdfPageExtension)
	Render	Render contents in a page to a device-independent bitmap specified by a Rectangle structure. (Defined by PdfPageExtension)
	Render	Render contents in a page to a drawing surface specified by a location and size. (Defined by PdfPageExtension)
	Render	Render contents in a page to the device context specified by a location and size. (Defined by PdfPageExtension)
	Render	Render contents in a page to a device-independent bitmap specified by a location and size. (Defined by PdfPageExtension)
	Render	Render contents in a page to a drawing surface specified by a coordinate pair, a width, and a height. (Defined by PdfPageExtension)
	StartProgressiveRender	Start to render page contents to a device independent bitmap progressively specified by a Rectangle structure. (Defined by PdfPageExtension)
	StartProgressiveRender	Start to render page contents to a device independent bitmap progressively specified by a location and size. (Defined by PdfPageExtension)

Top

Reference

Patagames.Pdf.Net Namespace

PdfPage Class

Field Value

Reference