LoadAnnotations Method

Example-VB Example-VC++

Loads annotations from a file and places them on the image currently being displayed.

Available With

Ö Imaging for Windows Professional Edition V2.0
Imaging for Windows Professional Edition V1.0 and V1.1
Imaging for Windows 95 and 98
Imaging for Windows NT 4.0

Applies To

Image Edit control

Syntax

object.LoadAnnotations FileName,StartPage,EndPage,Flags

Arguments

Parameter Data Type Setting

FileName String The fully-qualified name of the file containing the annotations
StartPage Long The starting page in the currently displayed file where the first annotation will be placed
EndPage Long The ending page in the currently displayed file where the last annotation will be placed
Flags Long Not used currently

Return Value

Long

Value Description

0 Failed
1 Success

Remarks

The Display method must be invoked prior to calling this method.

To support StartPage and EndPage parameter entries that span more than one page, the image file on display must be a multipage image file type (AWD or TIFF).

Notes Regarding the StartPage and EndPage Parameters

If the StartPage parameter is set to 5, the first annotation will be placed on page 5 of the image file currently on display.  If the EndPage parameter is set to 8, the first four groups of annotations will be placed on pages 5, 6, 7 and 8 of the image file currently on display.  If there are more annotations than pages, or more pages than annotations, the LoadAnnotations method will perform the best fit it can.

After invoking the LoadAnnotations method, the Save, SaveAs, or SavePage method must be invoked to save the altered image.  Unless the current image is a TIFF image, annotations must be burned-in to be saved.