PdfPage Class

Class for a PdfDocument page.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfPage

Namespace:  BitMiracle.Docotic.Pdf
Assembly:  BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)

Syntax

C#
public sealed class PdfPage
VB
Public NotInheritable Class PdfPage

The PdfPage type exposes the following members.

Properties

  NameDescription
Public propertyArtBox
Gets or sets the art box of the page.
Public propertyBleedBox
Gets or sets the bleed box of the page.
Public propertyCanvas
Gets the page canvas.
Public propertyControlCount
Gets the number of controls associated with this page.
Public propertyControls
Gets the collection of controls associated with this page.
Public propertyCropBox
Gets or sets the crop box of the page.
Public propertyDictionary
Gets the low-level dictionary object for this page object.
Public propertyGroup
Gets or sets the transparency group parameters of this page.
Public propertyHeight
Gets or sets the height of the page, expressed in PDF's default user space units.
Public propertyMediaBox
Gets or sets the media box of the page.
Public propertyOrientation
Gets or sets the PdfPaperOrientation value specifying the orientation of the page.
Public propertyResolution
Gets the resolution of the canvas.
Public propertyRotation
Gets or sets the PdfRotation value specifying the rotation of the page.
Public propertySize
Gets or sets the PdfPaperSize value specifying the size of the page.
Public propertyThumbnail
Gets or sets the thumbnail image to be used for this page by a viewer application instead of auto-generated image of the contents of this page in miniature form.
Public propertyTrimBox
Gets or sets the trim box of the page.
Public propertyUserUnit
Gets or sets the size of default user space units.
Public propertyWidgetCount
Gets the number of widgets (annotations and controls) associated with this page.
Public propertyWidgets
Gets the collection of widgets (annotations and controls) associated with this page.
Public propertyWidth
Gets or sets the width of the page, expressed in PDF's default user space units.
Public propertyXObjectCount
Gets the number of form XObjects associated with this page.
Public propertyXObjects
Gets the collection of form XObjects associated with this page.

Methods

  NameDescription
Public methodAdd3dAnnotation(PdfRectangle, Pdf3dStream)
Adds the new 3D annotation based on 3D data from Pdf3dStream.
Public methodAdd3dAnnotation(PdfRectangle, Stream)
Adds the new 3D annotation based on 3D data from Stream.
Public methodAdd3dAnnotation(PdfRectangle, String)
Adds the new 3D annotation based on 3D data from the file.
Public methodAddActionArea(PdfRectangle, PdfAction)
Adds the new action area to the PdfPage.
Public methodAddActionArea(PdfPoint, PdfSize, PdfAction)
Adds the new action area to the PdfPage.
Public methodAddActionArea(Double, Double, Double, Double, PdfAction)
Adds the new action area to the PdfPage.
Public methodAddButton(PdfRectangle)
Adds the new button control with auto-generated name to the PdfPage.
Public methodAddButton(PdfPoint, PdfSize)
Adds the new button control with auto-generated name to the PdfPage.
Public methodAddButton(String, PdfRectangle)
Adds the new button control with specified unique name to the PdfPage.
Public methodAddButton(String, PdfPoint, PdfSize)
Adds the new button control with specified unique name to the PdfPage.
Public methodAddButton(Double, Double, Double, Double)
Adds the new button control with auto-generated name to the PdfPage.
Public methodAddButton(String, Double, Double, Double, Double)
Adds the new button control with specified unique name to the PdfPage.
Public methodAddCheckBox(PdfRectangle)
Adds the new check box control with auto-generated name to the PdfPage.
Public methodAddCheckBox(PdfPoint, Double)
Adds the new check box control with auto-generated name to the PdfPage.
Public methodAddCheckBox(PdfRectangle, String)
Adds the new check box control with auto-generated name and caption to the PdfPage.
Public methodAddCheckBox(String, PdfRectangle)
Adds the new check box control with specified unique name to the PdfPage.
Public methodAddCheckBox(Double, Double, Double)
Adds the new check box control with auto-generated name to the PdfPage.
Public methodAddCheckBox(PdfPoint, PdfSize, String)
Adds the new check box control with auto-generated name and caption to the PdfPage.
Public methodAddCheckBox(String, PdfPoint, Double)
Adds the new check box control with specified unique name to the PdfPage.
Public methodAddCheckBox(String, PdfRectangle, String)
Adds the new check box control with specified unique name and caption to the PdfPage.
Public methodAddCheckBox(String, PdfPoint, PdfSize, String)
Adds the new check box control with specified unique name and caption to the PdfPage.
Public methodAddCheckBox(String, Double, Double, Double)
Adds the new check box control with specified unique name to the PdfPage.
Public methodAddCheckBox(Double, Double, Double, Double, String)
Adds the new check box control with auto-generated name and caption to the PdfPage.
Public methodAddCheckBox(String, Double, Double, Double, Double, String)
Adds the new check box control with specified unique name and caption to the PdfPage.
Public methodAddComboBox(PdfRectangle)
Adds the new combo box control with auto-generated name to the PdfPage.
Public methodAddComboBox(PdfPoint, PdfSize)
Adds the new combo box control with auto-generated name to the PdfPage.
Public methodAddComboBox(String, PdfRectangle)
Adds the new combo box control with specified unique name to the PdfPage.
Public methodAddComboBox(String, PdfPoint, PdfSize)
Adds the new combo box control with specified unique name to the PdfPage.
Public methodAddComboBox(Double, Double, Double, Double)
Adds the new combo box control with auto-generated name to the PdfPage.
Public methodAddComboBox(String, Double, Double, Double, Double)
Adds the new combo box control with specified unique name to the PdfPage.
Public methodAddFileAnnotation
Adds the new file attachment annotation to the PdfPage.
Public methodAddHighlightAnnotation
Adds the new highlight annotation to the PdfPage.
Public methodAddHyperlink(PdfRectangle, Uri)
Adds the new hyperlink area to the PdfPage.
Public methodAddHyperlink(PdfPoint, PdfSize, Uri)
Adds the new hyperlink area to the PdfPage.
Public methodAddHyperlink(Double, Double, Double, Double, Uri)
Adds the new hyperlink area to the PdfPage.
Public methodAddInkAnnotation
Adds the new ink annotation to the PdfPage.
Public methodAddJaggedUnderlineAnnotation
Adds the new jagged-underline annotation to the PdfPage.
Public methodAddLinkToPage(PdfRectangle, PdfPage)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfRectangle, Int32)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfPoint, PdfSize, PdfPage)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfPoint, PdfSize, Int32)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfRectangle, PdfPage, Double)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfRectangle, Int32, Double)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfPoint, PdfSize, PdfPage, Double)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(PdfPoint, PdfSize, Int32, Double)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(Double, Double, Double, Double, PdfPage)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(Double, Double, Double, Double, Int32)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(Double, Double, Double, Double, PdfPage, Double)
Adds the new link area to the PdfPage.
Public methodAddLinkToPage(Double, Double, Double, Double, Int32, Double)
Adds the new link area to the PdfPage.
Public methodAddListBox(PdfRectangle)
Adds the new list box control with auto-generated name to the PdfPage.
Public methodAddListBox(PdfPoint, PdfSize)
Adds the new list box control with auto-generated name to the PdfPage.
Public methodAddListBox(String, PdfRectangle)
Adds the new list box control with specified unique name to the PdfPage.
Public methodAddListBox(String, PdfPoint, PdfSize)
Adds the new list box control with specified unique name to the PdfPage.
Public methodAddListBox(Double, Double, Double, Double)
Adds the new list box control with auto-generated name to the PdfPage.
Public methodAddListBox(String, Double, Double, Double, Double)
Adds the new list box control with specified unique name to the PdfPage.
Public methodAddRadioButton(PdfRectangle)
Adds the new radio button control with auto-generated radio button group name to the PdfPage.
Public methodAddRadioButton(PdfPoint, Double)
Adds the new radio button control with auto-generated radio button group name to the PdfPage.
Public methodAddRadioButton(PdfRectangle, String)
Adds the new radio button control with auto-generated radio button group name and caption to the PdfPage.
Public methodAddRadioButton(String, PdfRectangle)
Adds the new radio button control with specified unique radio button group name to the PdfPage.
Public methodAddRadioButton(Double, Double, Double)
Adds the new radio button control with auto-generated radio button group name to the PdfPage.
Public methodAddRadioButton(PdfPoint, PdfSize, String)
Adds the new radio button control with auto-generated radio button group name and caption to the PdfPage.
Public methodAddRadioButton(String, PdfPoint, Double)
Adds the new radio button control with specified unique radio button group name to the PdfPage.
Public methodAddRadioButton(String, PdfRectangle, String)
Adds the new radio button control with specified unique radio button group name and caption to the PdfPage.
Public methodAddRadioButton(String, PdfPoint, PdfSize, String)
Adds the new radio button control with specified unique radio button group name and caption to the PdfPage.
Public methodAddRadioButton(String, Double, Double, Double)
Adds the new radio button control with specified unique radio button group name to the PdfPage.
Public methodAddRadioButton(Double, Double, Double, Double, String)
Adds the new radio button control with auto-generated radio button group name and caption to the PdfPage.
Public methodAddRadioButton(String, Double, Double, Double, Double, String)
Adds the new radio button control with specified unique radio button group name and caption to the PdfPage.
Public methodAddRichMediaAnnotation
Adds the new rich media annotation to the PdfPage.
Public methodAddSignatureField(PdfRectangle)
Adds a new unsigned signature field control with auto-generated name to the PdfPage.
Public methodAddSignatureField(PdfPoint, PdfSize)
Adds a new unsigned signature field control with auto-generated name to the PdfPage.
Public methodAddSignatureField(String, PdfRectangle)
Adds a new unsigned signature field control with specified unique name to the PdfPage.
Public methodAddSignatureField(String, PdfPoint, PdfSize)
Adds a new unsigned signature field control with specified unique name to the PdfPage.
Public methodAddSignatureField(Double, Double, Double, Double)
Adds a new unsigned signature field control with auto-generated name to the PdfPage.
Public methodAddSignatureField(String, Double, Double, Double, Double)
Adds a new unsigned signature field control with specified unique name to the PdfPage.
Public methodAddStrikeoutAnnotation
Adds the new strikeout annotation to the PdfPage.
Public methodAddTextAnnotation(PdfPoint, String)
Adds the new text annotation to the PdfPage.
Public methodAddTextAnnotation(PdfPoint, String, String)
Adds the new text annotation to the PdfPage.
Public methodAddTextAnnotation(Double, Double, String, String)
Adds the new text annotation to the PdfPage.
Public methodAddTextBox(PdfRectangle)
Adds the new text box control with auto-generated name to the PdfPage.
Public methodAddTextBox(PdfPoint, PdfSize)
Adds the new text box control with auto-generated name to the PdfPage.
Public methodAddTextBox(String, PdfRectangle)
Adds the new text box control with specified unique name to the PdfPage.
Public methodAddTextBox(String, PdfPoint, PdfSize)
Adds the new text box control with specified unique name to the PdfPage.
Public methodAddTextBox(Double, Double, Double, Double)
Adds the new text box control with auto-generated name to the PdfPage.
Public methodAddTextBox(String, Double, Double, Double, Double)
Adds the new text box control with specified unique name to the PdfPage.
Public methodAddUnderlineAnnotation
Adds the new underline annotation to the PdfPage.
Public methodEquals (Inherited from Object.)
Public methodGetChars
Retrieves collection of all characters drawn on the page with their bounding rectangles.
Public methodGetControl
Gets the control with the specified index from the collection of controls associated with this page.
Public methodGetHashCode (Inherited from Object.)
Public methodGetImages()
Returns the enumerator that iterates through the collection of page images including inline images.
Public methodGetImages(Boolean)
Returns the enumerator that iterates through the collection of page images including or excluding the inline images.
Public methodGetObjects()
Retrieves collection of all objects drawn on the page.
Public methodGetObjects(PdfObjectExtractionOptions)
Retrieves collection of all objects drawn on the page.
Public methodGetPaintedImages
Gets the collection of PdfPaintedImage objects for all images painted on the page.
Public methodGetSortedControls
Gets the sorted collection controls associated with this page.
Public methodGetSortedWidgets
Gets the sorted collection of widgets (annotations and controls) associated with this page.
Public methodGetText()
Retrieves all text drawn on the page in plain text format.
Public methodGetText(PdfTextExtractionOptions)
Retrieves all text drawn on the page according to specified options.
Public methodGetTextWithFormatting
Retrieves all text drawn on the page formatted as seen in a PDF viewer.
Public methodGetType (Inherited from Object.)
Public methodGetWidget
Gets the widget with the specified index from the collection of controls associated with this page.
Public methodGetWords
Retrieves collection of all words drawn on the page with their bounding rectangles.
Public methodGetXObject
Gets the XObject with the specified index.
Public methodHasOverprint
Determines if this page uses overprinting for any of its painting operations.
Public methodMergeContentStreams
Tries to merge content streams of this page to a single stream.
Public methodRemovePaintedImages
Removes some or all images drawn on the page depending on a provided predicate.
Public methodRemovePaths
Removes some or all vector paths drawn on the page depending on a provided predicate.
Public methodSave(Stream, PdfDrawOptions)
Saves an image of the page to the specified stream.
Public methodSave(String, PdfDrawOptions)
Saves an image of the page to the file with specified name.
Public methodToString (Inherited from Object.)

Extension Methods

  NameDescription
Public Extension MethodDraw
Draws the page on a Graphics.
(Defined by PdfPageGdiExtensions.)

See Also