Winnovative HTML to PDF Converter

ImageElement Class

Winnovative HTML to PDF Converter for .NET Documentation
Objects of this class can be added to a PDF document to render images
Inheritance Hierarchy

SystemObject
  WinnovativePageElement
    WinnovativePageGraphicElement
      WinnovativeImageElement

Namespace:  Winnovative
Assembly:  wnvhtmltopdf (in wnvhtmltopdf.dll) Version: 17.0.0.0
Syntax

public class ImageElement : PageGraphicElement

The ImageElement type exposes the following members.

Constructors

  NameDescription
Public methodImageElement
Constructs an empty image element. The InitPdfImage method must be called after construction to initialize the image element
Public methodImageElement(Single, Single, Image)
Creates an ImageElement object from the specified Image object that will be rendered at the position (x,y) with a width equal to the available space in page and the height auto determined to keep the aspect ratio.
Public methodImageElement(Single, Single, String)
Creates an ImageElement object from the specified file that will be rendered at the position (x,y) with the width equal to available width in page and the height auto determined to keep the initial aspect ratio.
Public methodImageElement(Single, Single, Single, Image)
Creates an ImageElement object from the specified Image object that will be rendered at the position (x,y) with the specified width destWidth and the height auto determined to keep the aspect ratio.
Public methodImageElement(Single, Single, Single, String)
Creates an ImageElement object from the specified file that will be rendered at the position (x,y) with the specified width destWidth and the height auto determined to keep the initial aspect ratio.
Public methodImageElement(Single, Single, Single, Single, Image)
Creates an ImageElement object from the specified Image object that will be rendered at the position (x,y) with the (destWidth,destHeight) size keeping the aspect ratio.
Public methodImageElement(Single, Single, Single, Single, String)
Creates an ImageElement from the specified file that will be rendered at the position (x,y) with the (destWidth,destHeight) size keeping the aspect ratio.
Public methodImageElement(Single, Single, Single, Single, Boolean, Image)
Creates an ImageElement object from the specified Image object that will be rendered at the position (x,y) with the (destWidth,destHeight) size.
Public methodImageElement(Single, Single, Single, Single, Boolean, String)
Creates an ImageElement from the specified file that will be rendered at the position (x,y) with the (destWidth,destHeight) size.
Top
Properties

  NameDescription
Public propertyBackColor
Gets or sets element background color.
(Inherited from PageGraphicElement.)
Public propertyBlending
Gets or sets blending mode for transparent rendering mode of the element.
(Inherited from PageGraphicElement.)
Public propertyClipRectangle
The clip rectangle applied when the element is rendered in PDF
(Inherited from PageGraphicElement.)
Public propertyDestHeight
Gets or sets the image destination height in PDF page
Public propertyDestWidth
Gets or sets the image destination width in PDF page
Public propertyEnlargeEnabled
A flag indicating if the image can be enlarged if necessary to fit the destination in PDF. The default value of the property is true
Public propertyForeColor
Gets or sets the element foreground color.
(Inherited from PageGraphicElement.)
Public propertyGradient
The gradient used to fill a shape.
(Inherited from PageGraphicElement.)
Public propertyImageObj
Gets the underlying image object
Public propertyInsertNewPagesMode
A flag indicating if the Image element will always insert a new page in the PDF document when rendering next page instead of trying to use an already existing PDF page. This property is false by default
Public propertyKeepAspectRatio
A flag indicating if the aspect ratio of the image should be kept when the image is rendered in PDF. The default value of the property is true
Public propertyLineStyle
Gets or sets the line style for elements rendering lines.
(Inherited from PageGraphicElement.)
Public propertyOpacity
Gets or sets element opacity. The opacity is expressed as a value between 0 and 100. 0 means completely transparent and 100 completely opaque. The default value of this property is 100.
(Inherited from PageGraphicElement.)
Public propertyPaginate
When this property true the element can be paginated and rendered in many PDF pages
Public propertyRenderMultiFrame
Set this property to enable/disable multi-frame images rendering when necessary
Public propertyRenderTransparentImage
A flag indicating if the image alpha transparency information is used when the image is rendered in PDF. The default value is true. Set this property to true to use transparency information from the transparent PNG images and bitmap images with alpha channel when the image is rendered in PDF.
Public propertyRotated
A flag to indicate if this element was rotated.
(Inherited from PageGraphicElement.)
Public propertyScaled
A flag to indicate if this element was scaled.
(Inherited from PageGraphicElement.)
Public propertySkewed
A flag to indicate if this element was skewed.
(Inherited from PageGraphicElement.)
Public propertyTranslated
A flag to indicate if this element was translated.
(Inherited from PageGraphicElement.)
Public propertyXLocation
Gets or sets the image element location on X in PDF page
Public propertyYLocation
Gets or sets the image element location on Y in PDF page
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.)
Public methodInitPdfImage(Single, Single, Single, String)
Initializes an image element from a file. This method must be called on empty image elements
Public methodInitPdfImage(Single, Single, Single, Single, String)
Initializes an image element from a file keeping the aspect ratio. This method must be called on empty image elements
Public methodInitPdfImage(Single, Single, Single, Single, Boolean, String)
Initializes an image element from a file. This method must be called on empty image elements
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRotate
Rotates the coordinate system axes clockwise by the specified angle before rendering the element. The coordinates of the element are relative to the rotated coordinates system.
(Inherited from PageGraphicElement.)
Public methodScale
Scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system is the same size as sx and sy units, respectively, in the previous coordinate system.
(Inherited from PageGraphicElement.)
Public methodSkew
Skews the x axis by an skewXAngle and the y axis by an skewYAngle before rendering the element.
(Inherited from PageGraphicElement.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTranslate
Translates the coordinate system before rendering the element. The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement.)
Top
Events

  NameDescription
Public eventAfterRenderPdfPageEvent
The event is raised right after the Image Element finished PDF page rendering. The PDF page configuration like size, orientation, header or footer is already defined and cannot be changed. In the handler of this event PDF elements can be added in the foreground of the rendered PDF page.
Public eventBeforeRenderPdfPageEvent
The event is raised right before the page is rendered by Image element. The PDF page configuration like size, orientation, header or footer is already defined and cannot be changed. In the handler of this event PDF elements can be added in the background of the PDF page to be rendered.
Public eventPrepareRenderPdfPageEvent
The event is raised after the Image element created the PDF page and before starting rendering it. In the handler of this event the PDF page configuration like size, orientation, header or footer can still be changed before starting rendering.
Top
See Also

Reference