AddStampAnnotationFromImage
Annotations and hotspot links
Description
Adds a custom stamp annotation to the selected page. The values of the color parameters range from 0 to 1, with 0 indicating 0% and 1 indicating 100% of the color. The color only affects the background color of the popup and not the stamp itself.
Syntax
Delphi
Function TPDFlib.AddStampAnnotationFromImage(Left, Top, Width, Height: Double; Const FileName: WideString; Const Title, Contents: WideString; Red, Green, Blue: Double; Options: Integer): Integer;
ActiveX
Function PDFlib::AddStampAnnotationFromImage(Left As Double, Top As Double, Width As Double, Height As Double, FileName As String, Title As String, Contents As String, Red As Double, Green As Double, Blue As Double, Options As Long) As Long
DLL
int DLAddStampAnnotationFromImage(int InstanceID, double Left, double Top, double Width, double Height, const wchar_t * FileName, const wchar_t * Title, const wchar_t * Contents, double Red, double Green, double Blue, int Options);
Parameters
Left
The horizontal coordinate of the left edge of the stamp annotation
Top
The vertical coordinate of the top edge of the stamp annotation
Width
The width of the annotation
The height of the annotation
Height
FileName
Complete FilePath to the image
Title
The title of the popup annotation
Contents
The contents of the popup annotation
Red
The red component of the popup annotation's background color
Green
The green component of the popup annotation's background color
The blue component of the popup annotation's background color
Blue
Reserved for future use. Should always be set to 0.
Options
Return values
| 0 | The stamp annotation could not be added to the page |
|---|---|
| 1 | Success |