LImageViewerCell::LoadAnnotation

#include "ltwrappr.h"

L_INT LImageViewerCell::LoadAnnotation(pFileName, nSubCellIndex, nStartPage, uFlags)

LPTSTR pFileName;

/* name of the file to load */

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_INT nStartPage;

/* page index to load */

L_UINT uFlags;

/* reserved for future */

Loads the annotation file into the specified cell or sub-cell.

Parameter

Description

pFileName

Character string that contains the name of the file to load.

nSubCellIndex

A zero-based index into the image list attached to the cell specified in I. This sub-cell contains the image that the annotation will be loaded into. Pass -2 to refer to the selected sub-cell. If the cell contains 1 frame then the nSubCellIndex should be 0.

nStartPage

The file page that loading the annotation will start from.

uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

 

Value

Meaning

 

CELL_APPLYTOTHIS

[0x00000000] Apply the feature to this cell only.

 

CELL_APPLYTOALL

[0x10000000] Apply the feature to all the cells in the Image Viewer.

 

CELL_APPLYTOSELECTED

[0x20000000] Apply the feature to the selected cells in the Image Viewer.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function loads the annotation page saved by the LImageViewerCell::SaveAnnotation function.

Required DLLs and Libraries

LTIVW

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LImageViewerCell::SetAnnotationContainer, LImageViewerCell::AnnToRgn, LImageViewerCell::GetSelectedAnnotationAttributes, LImageViewerCell::EnableAnnotationCallBack, LImageViewerCell::GetAnnotationContainer, LImageViewerCell::EnableAnnotationCreatedCallBack, LImageViewerCell::SaveAnnotation, LImageViewerCell::AnnotationCreatedCallBack, LImageViewerCell::AnnotationCallBack, Class Members

Topics:

Image Viewer Cells

 

Window Control/Image Viewer Functions: Annotations

Example

For an example, refer to LImageViewerCell::SaveAnnotation.