HiQPdf Documentation

PdfImage Class

Quickly Create High Quality PDFs
The PDF image class representing an image that can be added to a PDF document
Inheritance Hierarchy

SystemObject
  HiQPdfPdfObject
    HiQPdfPdfDrawableObject
      HiQPdfPdfImage

Namespace:  HiQPdf
Assembly:  HiQPdf (in HiQPdf.dll) Version: 12.0.0.0
Syntax

public class PdfImage : PdfDrawableObject

The PdfImage type exposes the following members.

Constructors

  NameDescription
Public methodPdfImage
Constructs an empty PDF image. The SetPdfImage(Single, Single, Single, String) method must be called after the object creation
Public methodPdfImage(RectangleF, Image)
Constructs a PDF image from the given .NET image to be laid out in the given destination rectangle in a PDF canvas. The aspect ratio of the image is preserved in PDF
Public methodPdfImage(RectangleF, String)
Constructs a PDF image from the given image file to be laid out in the given destination rectangle in a PDF canvas. The aspect ratio of the image is preserved in PDF
Public methodPdfImage(RectangleF, Boolean, Image)
Constructs a PDF image from the given .NET image to be laid out in the given destination rectangle in a PDF canvas
Public methodPdfImage(RectangleF, Boolean, String)
Constructs a PDF image from the given image file to be laid out in the given destination rectangle in a PDF canvas
Public methodPdfImage(Single, Single, Image)
Constructs an image from the given .NET image to be laid out at the given coordinate in a PDF canvas. The destination width in PDF is the available width in canvas
Public methodPdfImage(Single, Single, String)
Constructs a PDF image from the given image file to be laid out at the given coordinate in a PDF canvas The destination width in PDF is the available width in canvas
Public methodPdfImage(Single, Single, Single, Image)
Constructs an image from the given .NET image to be laid out at the given coordinate and in the given width in a PDF canvas
Public methodPdfImage(Single, Single, Single, String)
Constructs a PDF image from the given image file to be laid out at the given coordinate and in the given width in a PDF canvas
Top
Properties

  NameDescription
Public propertyAlphaBlending
Controls if the alpha blending is enabled when drawing this image in PDF. This property is true by default
Public propertyBackColor
The PDF object back color
(Inherited from PdfDrawableObject.)
Public propertyBlendingMode
The blending mode when this object is drawn in PDF. This property is Normal by default
(Inherited from PdfDrawableObject.)
Public propertyCanGrow
Controls if the image can grow to fit the destination in PDF. This property is true by default
Public propertyClipRectangle
The clip rectangle applied when drawing the object in PDF
(Inherited from PdfDrawableObject.)
Public propertyCropping
Controls is the image is cropped at the end of PDF page where it is rendered. This property is false by default and the image can continue on the next page if necessary
Public propertyForceNewPdfPages
Controls if a new PDF page is always created when the image object is laid out on the next PDF page. By default this property is false and if there is a next page already created in PDF document it will be used to layout this object
Public propertyForeColor
The PDF object fore color
(Inherited from PdfDrawableObject.)
Public propertyGradient
The PDF object gradient color
(Inherited from PdfDrawableObject.)
Public propertyLineStyle
The style of the lines rendered by this object
(Inherited from PdfDrawableObject.)
Public propertyMultiPage
Controls if the all the frames in the image are rendered in PDF. This property is true by default and each frame in the image is rendered in a new PDF page
Public propertyOpacity
The element opacity as a value between 0 which means completely transparent to 100 which means completely opaque. The object is completely opaque by default
(Inherited from PdfDrawableObject.)
Public propertyPreserveAspectRatio
Controls if the aspect ratio of the image is preserved in PDF. This property is true by default
Public propertySelectedFrame
The index of the frame in a multi frame image selected for rendering. This property is 0 by default and has effect only when MultiPage property is false
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetPdfImage(Single, Single, Single, String)
Constructs a PDF image from the given image file to be laid out at the given coordinate and in the given width in a PDF canvas. This method can be called only on an empty PDF image
Public methodSetPdfImage(Single, Single, Single, Single, String)
Constructs a PDF image from the given image file to be laid out at the given coordinate and in the given width in a PDF canvas. The aspect ratio of the image is preserved in PDF. This method can be called only on an empty PDF image
Public methodSetPdfImage(Single, Single, Single, Single, Boolean, String)
Constructs a PDF image from the given image file to be laid out at the given coordinate and in the given width in a PDF canvas. This method can be called only on an empty PDF image
Public methodSetRotationAngle
Sets the clockwise rotation angle of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject.)
Public methodSetScaling
Sets the horizontal and vertical scaling of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject.)
Public methodSetSkewAngles
Sets the clockwise skew angles of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject.)
Public methodSetTranslation
Sets the horizontal and vertical translation of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventPageCreatingEvent
This event can be used to configure the PDF page before starting layouting. For example, it is possible to set a custom header and footer for page or to hide the header and footer from page. The event handler must be set before adding this object to a page
Public eventPageLayoutingEndedEvent
The event is raised after the converter finished to layout the objects in a PDF page. This event can be used to layout PDF objects in the foreground of the PDF page after the main HTML content was laid out in page. The event handler must be set before adding this object to a page
Public eventPageLayoutingEvent
The event is raised when the Image object prepares to layout the objects in a PDF page. This event can be used to layout PDF objects in the background of the PDF page before the main HTML content is laid out in page. The event handler must be set before adding this object to a page
Top
See Also

Reference