In This Topic ▼

LAnnNote::GetTextAlign

Summary

Gets the text alignment of an annotation.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnNote::GetTextAlign(puTextAlign)

Parameters

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 a note 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.

Example

Sample for LAnnNote::SetTextAlign, LAnnNote::GetTextAlign
This example changes the text alignment of a note annotation object.

L_INT LAnnNote_GetTextAlignExample(LAnnNote *pLNote)  
{ 
   L_INT nRet; 
   L_UINT uTextAlign;  
   L_TCHAR szMsg[100];  
   L_UINT uType;  
    
   nRet = pLNote->GetTextAlign(&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= pLNote->SetTextAlign(uTextAlign, 0);  
   if (nRet != SUCCESS)  
   { 
      uType = pLNote->GetType(); 
      wsprintf(szMsg, TEXT("SetTextAlign Error: %d on object type[%d]\n"), nRet, uType);  
      MessageBox(NULL, szMsg, TEXT("Error"), MB_OK);  
      return nRet; 
   } 
   return SUCCESS; 
}