PdfXObject Class

Class for a PDF form XObject.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfXObject

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

Syntax

C#
public sealed class PdfXObject
VB
Public NotInheritable Class PdfXObject

The PdfXObject type exposes the following members.

Properties

  NameDescription
Public propertyBoundingBox
Gets or sets the media box of the form XObject.
Public propertyCanvas
Gets the canvas of this XObject.
Public propertyDrawOnBackground
Gets or sets a value indicating whether this XObject should be drawn before any other contents of a page.
Public propertyGroup
Gets or sets the transparency group parameters of this XObject.
Public propertyHeight
Gets or sets the height of the XObject in pixels.
Public propertyId
Gets the identifier of this XObject in this PdfDocument.
Public propertyLayer
Gets or sets the layer to which this XObject belongs.
Public propertyMatrix
Gets or sets the form matrix.
Public propertyOrientation
Gets or sets the PdfPaperOrientation value specifying the orientation of the XObject.
Public propertySize
Gets or sets the PdfPaperSize value specifying the size of the XObject.
Public propertyWidth
Gets or sets the width of the XObject in pixels.

Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Overrides Object.Equals(Object).)
Public methodGetHashCode
Serves as a hash function for a this type.
(Overrides Object.GetHashCode().)
Public methodGetObjects()
Retrieves collection of all objects drawn on this XObject.
Public methodGetObjects(PdfObjectExtractionOptions)
Retrieves collection of all objects drawn on this XObject.
Public methodGetType (Inherited from Object.)
Public methodToString
Returns a String that represents this instance.
(Overrides Object.ToString().)

Operators

  NameDescription
Public operatorStatic memberEquality
Determines whether the two specified objects are equal to each other.
Public operatorStatic memberInequality
Determines whether the two specified objects are not equal to each other.

Remarks

Any graphical element that is to be used repeatedly, such as a company logo, a watermark or a background can be defined as a form XObject.

A form XObject can serve as the template for an entire page.

See Also