AddStampAnnotationFromImageID

Annotations and hotspot links

Description

Adds a custom stamp annotation to the selected page based on the image ID that is already added to the document. The values of the colour parameters range from 0 to 1, with 0 indicating 0% and 1 indicating 100% of the colour. The colour only affects the background colour of the popup and not the stamp itself.

Syntax

Delphi

Function TPDFlib.AddStampAnnotationFromImageID(Left, Top, Width, Height: Double; ImageID: Integer; Const Title, Contents: WideString; Red, Green, Blue: Double; Options: Integer): Integer;

ActiveX

Function PDFlib::AddStampAnnotationFromImageID(Left As Double, Top As Double, Width As Double, Height As Double, ImageID As Long, Title As String, Contents As String, Red As Double, Green As Double, Blue As Double, Options As Long) As Long

DLL

int DLAddStampAnnotationFromImageID(int InstanceID, double Left, double Top, double Width, double Height, int ImageID, 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

Height

The height of the annotation

ID of the image that should be used as stamp

ImageID

Title

The title of the popup annotation

Contents

The contents of the popup annotation

Red

The red component of the popup annotation's background colour

Green

The green component of the popup annotation's background colour

Blue

The blue component of the popup annotation's background colour

Options

Reserved for future use. Should always be set to 0.

Return values