HiQPdf Client for .NET Core
Pdf
The PDF image class representing an image that can be added to a PDF document
Definition
Namespace: HiQPdfClient
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
C#
public class PdfImage : PdfDrawableObjectVB
Public Class PdfImage
Inherits PdfDrawableObjectC++
public ref class PdfImage : public PdfDrawableObjectF#
type PdfImage =
class
inherit PdfDrawableObject
end- Inheritance
- Object PdfObject PdfDrawableObject PdfImage
Constructors
| PdfImage(RectangleFloat, Byte) | 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 |
| PdfImage(RectangleFloat, 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 |
| PdfImage(RectangleFloat, Boolean, Byte) | Constructs a PDF image from the given .NET image to be laid out in the given destination rectangle in a PDF canvas |
| PdfImage(RectangleFloat, Boolean, String) | Constructs a PDF image from the given image file to be laid out in the given destination rectangle in a PDF canvas |
| PdfImage(Single, Single, Byte) | 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 |
| PdfImage(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 |
| PdfImage(Single, Single, Single, Byte) | 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 |
| PdfImage(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 |
Properties
| AlphaBlending | Controls if the alpha blending is enabled when drawing this image in PDF. This property is true by default |
| BackColor |
The PDF object back color
(Inherited from PdfDrawableObject) |
| BlendingMode |
The blending mode when this object is drawn in PDF.
This property is Normal by default
(Inherited from PdfDrawableObject) |
| CanGrow | Controls if the image can grow to fit the destination in PDF. This property is true by default |
| ClipRectangle |
The clip rectangle applied when drawing the object in PDF
(Inherited from PdfDrawableObject) |
| Cropping | 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 |
| DestHeight | The image destination height in PDF page |
| DestWidth | The image destination width in PDF page |
| DestX | The image X location in PDF page |
| DestY | The image Y location in PDF page |
| ForceNewPdfPages | 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 |
| ForeColor |
The PDF object fore color
(Inherited from PdfDrawableObject) |
| Gradient |
The PDF object gradient color
(Inherited from PdfDrawableObject) |
| ImageData | The image data |
| LineStyle |
The style of the lines rendered by this object
(Inherited from PdfDrawableObject) |
| MultiPage | 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 |
| Opacity |
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) |
| PreserveAspectRatio | Controls if the aspect ratio of the image is preserved in PDF. This property is true by default |
Methods
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| SetRotationAngle |
Sets the clockwise rotation angle of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| SetScaling |
Sets the horizontal and vertical scaling of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| SetSkewAngles |
Sets the clockwise skew angles of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| SetTranslation |
Sets the horizontal and vertical translation of the coordinates system before drawing this object in PDF
(Inherited from PdfDrawableObject) |
| ToString | (Inherited from Object) |