Objects of this class can be added to a PDF document to render images
Inheritance Hierarchy
WnvWordToPdfPageElement
WnvWordToPdfPageGraphicElement
WnvWordToPdfImageElement
Namespace: WnvWordToPdf
Assembly: wnvwordtopdf (in wnvwordtopdf.dll) Version: 10.0.0.0
Syntax
The ImageElement type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ImageElement |
Constructs an empty image element. The InitPdfImage method must be called after construction to initialize the image element
| |
ImageElement(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.
| |
ImageElement(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.
| |
ImageElement(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.
| |
ImageElement(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.
| |
ImageElement(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.
| |
ImageElement(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.
| |
ImageElement(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.
| |
ImageElement(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.
|
Properties
Name | Description | |
---|---|---|
BackColor |
Gets or sets element background color.
(Inherited from PageGraphicElement.) | |
Blending |
Gets or sets blending mode for transparent rendering mode of the element.
(Inherited from PageGraphicElement.) | |
ClipRectangle |
The clip rectangle applied when the element is rendered in PDF
(Inherited from PageGraphicElement.) | |
DestHeight |
Gets or sets the image destination height in PDF page
| |
DestWidth |
Gets or sets the image destination width in PDF page
| |
EnlargeEnabled |
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
| |
ForeColor |
Gets or sets the element foreground color.
(Inherited from PageGraphicElement.) | |
Gradient |
The gradient used to fill a shape.
(Inherited from PageGraphicElement.) | |
ImageObj |
Gets the underlying image object
| |
InsertNewPagesMode |
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
| |
KeepAspectRatio |
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
| |
LineStyle |
Gets or sets the line style for elements rendering lines.
(Inherited from PageGraphicElement.) | |
Opacity |
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.) | |
Paginate |
When this property true the element can be paginated and rendered in many PDF pages
| |
RenderMultiFrame |
Set this property to enable/disable multi-frame images rendering when necessary
| |
RenderTransparentImage |
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.
| |
Rotated |
A flag to indicate if this element was rotated.
(Inherited from PageGraphicElement.) | |
Scaled |
A flag to indicate if this element was scaled.
(Inherited from PageGraphicElement.) | |
Skewed |
A flag to indicate if this element was skewed.
(Inherited from PageGraphicElement.) | |
Translated |
A flag to indicate if this element was translated.
(Inherited from PageGraphicElement.) | |
XLocation |
Gets or sets the image element location on X in PDF page
| |
YLocation |
Gets or sets the image element location on Y in PDF page
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InitPdfImage(Single, Single, Single, String) |
Initializes an image element from a file. This method must be called on empty image elements
| |
InitPdfImage(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
| |
InitPdfImage(Single, Single, Single, Single, Boolean, String) |
Initializes an image element from a file. This method must be called on empty image elements
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Rotate |
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.) | |
Scale |
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.) | |
Skew |
Skews the x axis by an skewXAngle and the y axis by an skewYAngle
before rendering the element.
(Inherited from PageGraphicElement.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Translate |
Translates the coordinate system before rendering the element.
The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement.) |
Events
Name | Description | |
---|---|---|
AfterRenderPdfPageEvent |
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.
| |
BeforeRenderPdfPageEvent |
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.
| |
PrepareRenderPdfPageEvent |
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.
|
See Also