PDFImage is one of the PDF Builder objects, and is derived from PDFVisibleContent. PDFImage is used for inserting an image from the local drive to the PDF document. It contains properties that determine how the image will display.
To view the full hierarchy of the PDF Builder objects, find "pdfobject" in the Browser, right-click the object, and then select "Show Hierarchy” in the pop-up menu.
PDFImage provides the following properties. In addition, it inherits the properties from its parent, PDFVisibleContent.
|
PDFImage property |
Datatype |
Description |
|---|---|---|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
String |
Gets or sets the image file name. The supported file format: bmp, j2k, jp2, jpeg, jpf, jpg, jpx, png, svg, tif, and tiff. PDFWatermark does not support SVG images. |
|
|
PDFImageFitMethod |
Gets or sets the image fit method. |
|
|
Real |
Gets or sets the image transparency. The unit is percentage. If the value is 100%, it means transparent. If the value is 0, it means not transparent. |
|
PDFImage event |
Occurs |
|---|---|
|
Immediately before the Open event occurs in the window. |
|
|
Immediately after the Close event occurs in the window. |
PDFImage provides the following functions. In addition, it inherits the functions from its parent, PDFVisibleContent.
|
PDFImage function |
Datatype returned |
Description |
|---|---|---|
|
String |
Returns the name assigned to the control. |
|
|
PDFText |
Clones the current object. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
String |
Gets the URL that the current object links to. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Long |
Links the current object to the specified object. |
|
|
Boolean |
Adds an event to the end of the message queue for the control. |
|
|
Long |
Sets the URL that the current object links to. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
