LAnnotation::GetRestrictToContainer

#include "ltwrappr.h"

virtual L_INT LAnnotation::GetRestrictToContainer(pbRestrict)

L_BOOL * pbRestrict;

/* pointer to a variable */

Determines whether the annotation object is restricted to the container. This function is available in the Document/Medical Toolkits.

Parameter

Description

pbRestrict

Pointer to a boolean value that specifies whether to restrict the object to the container.  Possible values are:

 

Value

Meaning

 

TRUE

Restrict the object to the container.

 

FALSE

Do not restrict the object to the container.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Determines whether one or more annotation objects is restricted to the container.. If an object is restricted to the container, then no part of that object can be moved outside of the container using automation.

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.

See Also

Functions:

Class Members, LAnnContainer::Convert, LAnnContainer::HitTest, LAnnContainer::RestrictCursor, LAnnotation::SetRestrictToContainer, LAnnotation::Define2, LAnnotation::Define, LAnnotation::SetAutoSnapCursor, LAnnotation::GetAutoSnapCursor

Topics:

Annotation Functions: Object Properties

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Annotation Functions: Creating and Deleting Annotations

 

Types of Annotations

 

Annotation Functions: Implementing Custom Annotations

 

Annotation Functions: Creating Custom Annotations

 

Fixed Annotations

 

Minimizing Flicker With Double Buffering

 

Displaying and Manipulating Annotation Objects

Example

For an example, refer to LAnnotation::SetRestrictToContainer.