Click or drag to resize

PdfPage Class

Represents a PDF page inside document.
Inheritance Hierarchy
SystemObject
  Patagames.Pdf.NetPdfPage

Namespace: Patagames.Pdf.Net
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.89.2704
Syntax
public class PdfPage : IDisposable

The PdfPage type exposes the following members.

Properties
 NameDescription
Public propertyAdditionalActions Gets or sets the additional-actions defining actions to be performed when the page is opened or closed.
Public propertyAnnots Gets annotations associated with the page
Public propertyArtBox Gets or sets ArtBox of the page.
Public propertyBleedBox Gets or sets BleedBox of the page.
Public propertyCropBox Gets or sets CropBox of the page.
Public propertyDictionary Gets the page's dictionary
Public propertyDocument Gets the PDF document associated with the current page.
Public propertyHandle Gets the Pdfium SDK handle that the page is bound to
Public propertyHeight Gets page height (excluding non-displayable area) measured in points.One point is 1/72 inch (around 0.3528 mm)
Public propertyIsAvailable Gets a value that represents that whether the content of the current PDF page is available.
Public propertyIsDisposed Gets a value indicating whether the object has been disposed of.

Field Value

true if the page has been disposed of; otherwise, false.
Public propertyIsLoaded Gets a value indicating whether the page has been loaded.
Public propertyIsParsed Gets a value indicating whether the page content has been parsed.
Public propertyIsTransparency Gets a value that represents that whether the content of the current PDF page contains transparency.
Public propertyLinks Gets the collection of PDF links found in the current page.
Public propertyMediaBox Gets or sets MediaBox of the page.
Public propertyOriginalRotation Gets the rotation angle of the page in a saved document.
Public propertyPageIndex Gets the index of the page in the document.
Public propertyPageObjects Gets the collection of PDF page objects found in the current page.
Public propertyRotation Gets or sets the page rotation.
Public propertyTag Gets or sets the object that contains data about the page.
Public propertyText Getscurrent instance of PdfText class that represents information about all characters in a page.
Public propertyTrimBox Gets or sets TrimBox of the page.
Public propertyWidth Gets page width (excluding non-displayable area) measured in points.One point is 1/72 inch (around 0.3528 mm)
Top
Methods
 NameDescription
Public methodCancelProgressiveRender Release the resource allocate during page rendering. Need to be called after finishing rendering or cancel the rendering.
Public methodContinueProgressiveLoad Continue loading a PDF page.
Public methodContinueProgressiveRender Continue rendering a PDF page.
Public methodCreateAnnotations Creates an annotation collection for the page.
Public methodDeviceToPage(Int32, Int32, Int32, Int32, PageRotate, Int32, Int32) Convert the screen coordinate of a point to page coordinate.
Public methodDeviceToPage(Int32, Int32, Int32, Int32, PageRotate, Int32, Int32, Double, Double) Convert the screen coordinate of a point to page coordinate.
Public methodDispose Dispose PDFPage object.
Protected methodDispose(Boolean) Releases all resources used by the PdfPage object.
Public methodDoPageAAction This method is required for performing the page object's additional-action when opened or closed.
Protected methodFinalize Finalize object
(Overrides ObjectFinalize)
Public methodFlattenPage Flat a pdf page, annotations or form fields will become part of the page contents.
Public methodStatic memberFromHandle Creates new instance of PdfPage class from page's hadle.
Public methodGenerateContent Generate PDF Page content.
Public methodGetControlAtPoint Get the field's widget at specified position.
Public methodGetFormFieldAtPoint Check the form field position by point.
Public methodInsertClipPath Clip the page content, the page content that outside the clipping region become invisible.
Protected methodOnDisposed Raises the Disposed event.
Public methodOnKeyDown You can call this member function when a key is pressed.
Public methodOnKeyUp You can call this member function when a key is released.
Public methodOnLButtonDown You can call this member function when the user presses the left mouse button.
Public methodOnLButtonUp You can call this member function when the user releases the left mouse button.
Protected methodOnLoaded Raises the Loaded event.
Public methodOnMouseMove You can call this member function when the mouse cursor moves.
Protected methodOnProgressiveRender Raises the ProgressiveRender event.
Public methodPageToDevice Convert the page coordinate of a point to screen coordinate
Public methodReloadPage Dispose and reload this page.
Public methodRender(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.
Public methodRender(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.
Public methodRenderEx Render contents in a page to a device-independent bitmap specified by a coordinate pair, a width, and a height.
Public methodRenderForms Render FormFeilds on a page to a device independent bitmap.
Public methodStartProgressiveLoad Start to load a page inside the document.
Public methodStartProgressiveRender Start to render page contents to a device independent bitmap progressively specified by a coordinate pair, a width, and a height.
Public methodTransformAnnots Transform (scale, rotate, shear, move) all annots in a page.
Public methodTransformWithClip Transform the whole page with a specified matrix, then clip the page content region.
Top
Events
 NameDescription
Public eventDisposed This event is triggered when the page is unloaded from the memory.
Public eventLoaded This event is triggered when the page is loaded into memory.
Public eventProgressiveRender SDK fire this event during rendering process initiated by {0} Overload method.
Top
Extension Methods
 NameDescription
Public Extension MethodDeviceToPageEx Convert the screen coordinate of a point to page coordinate.
(Defined by PdfPageExtension)
Public Extension MethodPageToDeviceEx Convert the page coordinate of a point to screen coordinate
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to a drawing surface specified by a Rectangle structure.
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to the device context specified by a Rectangle structure.
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to a device-independent bitmap specified by a Rectangle structure.
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to a drawing surface specified by a location and size.
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to the device context specified by a location and size.
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to a device-independent bitmap specified by a location and size.
(Defined by PdfPageExtension)
Public Extension MethodRender Render contents in a page to a drawing surface specified by a coordinate pair, a width, and a height.
(Defined by PdfPageExtension)
Public Extension MethodStartProgressiveRender Start to render page contents to a device independent bitmap progressively specified by a Rectangle structure.
(Defined by PdfPageExtension)
Public Extension MethodStartProgressiveRender Start to render page contents to a device independent bitmap progressively specified by a location and size.
(Defined by PdfPageExtension)
Top
See Also