Container Annotation Object

(Document and Medical Imaging toolkits)

The container annotation object (ANNOBJECT_CONTAINER) is a rectangle that is normally transparent, with a NULL line style. With the automated functions, its only purpose is to group other objects, including other container objects.

With low-level functions, you can insert and remove objects from a container, and you must specify the coordinates of an object relative to the container that it is in. The outermost (root) container establishes the frame of reference for all other objects, as explained in Low-Level Coordinate System for Annotations.

With low-level functions, you must specify the defining rectangle. Other applicable properties for the container have the following defaults, which you can change:

Visible

Defaults to FALSE. It can be changed using L_AnnSetVisible.

Selected

Defaults to FALSE. It can be changed using L_AnnSetSelected.

Foreground color

Defaults to black. It can be changed using L_AnnSetForeColor.

Background color

Defaults to white. It can be changed using L_AnnSetBackColor.

Line width

Defaults to 1. It can be changed using L_AnnSetLineWidth. (Values equate to a minimum of 1 pixel when displayed.)

Line style

Defaults to NULL. It can be changed using L_AnnSetLineStyle.

Fill pattern

Defaults to solid. It can be changed using L_AnnSetFillPattern.

Fill mode

Defaults to transparent. It can be changed using L_AnnSetFillMode.

Tag (identifier)

Defaults to 0. It can be changed using L_AnnSetTag.

Window handle

Defaults to NULL or the handle inherited from the container. It can be changed for all objects using L_AnnSetWnd.

User mode

Defaults to design mode or the mode inherited from the container. It can be changed for all objects using L_AnnSetUserMode.

Fixed State

Defaults to not fixed. It can be changed using L_AnnSetFixed.

Name

Defaults to empty string. It can be changed using L_AnnSetNameOptions.

Use the L_AnnSetOptions function and the L_AnnGetOptions function to control the following features:

For more information about these features, refer to Annotation Features.

If the annotation objects are container, automation, text, text pointer, stamp, note, pushpin, or button objects it is possible to use the L_AnnGetTextOptions and the L_AnnSetTextOptions functions to set the objects to show or hide the text and to set the color of the text. In addition, if the annotation objects are text or stamp objects these functions can set the objects to show or hide the borders of the object. These features must be enabled using the L_AnnSetOptions function.

The L_AnnSetFillMode and the L_AnnGetFillMode extends the original functions to support the ANNMODE_ALPHA fill mode. Before calling these two functions, enable the alpha background fill mode by calling the L_AnnSetOptions function.

Related topics:

Implementing Annotations.

Types of Annotations.

Low-Level Coordinate System for Annotations.

Annotation Objects - Automated Features

Help Version 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help