L_AnnCreateContainer

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnCreateContainer(hWnd, pRect, fVisible, phObject)

HWND hWnd;

/* handle to the window for the container */

pANNRECT pRect;

/* pointer to the structure that specifies the container */

L_BOOL fVisible;

/* flag that indicates whether the container will be visible */

pHANNOBJECT phObject;

/* address of the variable to be updated */

Creates and initializes an annotation object that is a container.

Parameter

Description

hWnd

Handle to the window for the container.

pRect

Pointer to the LEADTOOLS ANNRECT structure that specifies the container. The ANNRECT structure is like a Windows RECT structure, except that it uses double-precision floating point values.

 

Coordinates of an object's rectangle are relative to its container object. The coordinates are interpreted using the container's scaling factors and offsets, which are described in Low-Level Coordinate System for Annotations.

fVisible

Flag that indicates whether the container will be visible. Possible values are:

 

Value

Meaning

 

TRUE

The container is visible.

 

FALSE

The container is not visible.

phObject

Address of the variable to be updated with the handle to the annotation object.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

(Document and Medical) Before calling this function, you must declare a variable of data type HANNOBJECT. Then, pass the address of the variable in the phObject parameter. This function will update the variable with the handle of the new annotation object.

Required DLLs and Libraries

LTANN

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

Platforms

Win32, x64.

See Also

Functions:

L_AnnCreate, L_AnnCreateItem, L_AnnDefine,

 

L_AnnInsert, L_AnnRemove, L_AnnDestroy, L_AnnAddUserHandle, L_AnnAdjustPoint, L_AnnChangeUserHandle, L_AnnConvert, L_AnnDefine2, L_AnnDeleteUserHandle, L_AnnEnumerateHandles, L_AnnGetRestrictToContainer, L_AnnGetRotateAngle, L_AnnGetUserHandle, L_AnnGetUserHandles, L_AnnHitTest, L_AnnRestrictCursor, L_AnnSetRestrictToContainer

Topics:

Annotation Functions: Creating and Deleting Annotations

 

Implementing Annotations

 

Types of Annotations,

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program,

 

Implementing a Non-automated Annotation Program

 

Implementing Custom Annotations

Example

For an example, refer to Implementing a Non-automatic Annotation Program or Implementing an Automated Annotation Program. For complete sample code, refer to the ANNOTATE example.