LAnnTextPointer::GetTextPointerFixed

#include "ltwrappr.h"

virtual L_INT LAnnTextPointer::GetTextPointerFixed(pbPointerFixed)

L_BOOL *pbPointerFixed;

/* pointer to a variable to be updated */

Gets a value that indicates whether the pointer of an LAnnTextPointer object is fixed.

Parameter

Description

pbPointerFixed

Pointer to a variable to be updated with a value that specifies whether the pointer of an LAnnTextPointer is fixed. Possible values are:

 

Value

Meaning

 

TRUE

The pointer of the LAnnTextPointer object is fixed.

 

FALSE

The pointer of the LAnnTextPointer moves with the object.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

If pbPointerFixed is updated with TRUE, the text pointer of the object is fixed. When the text pointer is fixed, the location that the text pointer points to does not change when moving the object (either programatically or through automation).

If pbPointerFixed is updated with FALSE, the text pointer of the object is not fixed. This means that when the object is moved, the location the text pointer points to moves along with the 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.

See Also

Functions:

Class Members

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

 

Fixed Annotations

 

Minimizing Flicker With Double Buffering

Example

// Sample for LAnnTextPointer::GetTextPointerFixed, LAnnTextPointer::SetTextPointerFixed

// This example toggles the text pointer fixed state of an LAnnTextPointer object.

L_INT LAnnTextPointer_GetTextPointerFixedExample(LAnnTextPointer *pLTextPointer) 
{
	L_INT nRet; 
   L_BOOL bTextPointerFixed; 
   L_TCHAR szMsg[100]; 
   L_UINT uType; 
   
   nRet = pLTextPointer->GetTextPointerFixed( &bTextPointerFixed); 
	if(nRet != SUCCESS)
		return nRet;
   bTextPointerFixed = !bTextPointerFixed; 
   nRet= pLTextPointer->SetTextPointerFixed(bTextPointerFixed, 0); 
   if (nRet != SUCCESS) 
   {
      uType = pLTextPointer->GetType();
      wsprintf(szMsg, TEXT("SetTextPointerFixed Error: %d on object type[%d]\n"), nRet, uType); 
      MessageBox(NULL, szMsg, TEXT("Error"), MB_OK); 
		return nRet;
   }
	return SUCCESS;
}