In This Topic ▼

L_AnnGetTextAlign

Summary

Gets the text alignment of an annotation.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetTextAlign(hObject, puTextAlign)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_UINT *puTextAlign

Address of the variable to be updated with the object's text alignment. Possible values are:

Value	Meaning
TEXTALIGN_LEFT	[1] Align text to left.
TEXTALIGN_CENTER	[2] Center the text.
TEXTALIGN_RIGHT	[3] Align text to the right.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function gets the text alignment of certain annotation objects that display text.

The function is valid only for the following annotation objects:

ANNOBJECT_AUTOMATION
ANNOBJECT_NOTE
ANNOBJECT_TEXT
ANNOBJECT_TEXTPOINTER

Calling this function on an object other than those listed above will return ERROR_FEATURE_NOT_SUPPORTED.

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.

Example

This example changes the text alignment of a text, note, or text pointer annotation object.

L_INT AnnGetTextAlignExample(HANNOBJECT hObject) 
{ 
   L_INT    nRet; 
   L_UINT   uTextAlign; 
   L_TCHAR  szMsg[100]; 
   L_UINT   uType; 
 
   nRet = L_AnnGetTextAlign(hObject, &uTextAlign); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   switch (uTextAlign) 
   { 
   case TEXTALIGN_LEFT: 
      uTextAlign = TEXTALIGN_CENTER; 
      break; 
 
   case TEXTALIGN_CENTER: 
      uTextAlign = TEXTALIGN_RIGHT; 
      break; 
 
   case TEXTALIGN_RIGHT: 
      uTextAlign = TEXTALIGN_LEFT; 
      break; 
 
   } 
 
   nRet = L_AnnSetTextAlign(hObject, uTextAlign, 0); 
   if (nRet != SUCCESS) 
   { 
      L_AnnGetType(hObject, &uType); 
      wsprintf(szMsg, TEXT("L_AnnSetTextAlign Error: %d on object type[%d]\n"), nRet, uType); 
      _tprintf(_T("%s"), szMsg); 
      return nRet; 
   } 
 
   return SUCCESS; 
}