AddStampAnnotationFromImageA

Annotations and hotspot links

Description

The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to AddStampAnnotationFromImage and string arguments are interpreted using the current SetAnsiMode code page

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 DLAddStampAnnotationFromImageA(InstanceID: Integer; Left, Top, Width, Height: Double; FileName, Title, Contents: PAnsiChar; Red, Green, Blue: Double; Options: Integer): Integer;

DLL

int DLAddStampAnnotationFromImageA(int InstanceID, double Left, double Top, double Width, double Height, const char * FileName, const char * Title, const char * 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

0The stamp annotation could not be added to the page
1Success