LAnnAutomation::GetTextAlign

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetTextAlign(puTextAlign)

L_UINT *puTextAlign;

/* address of a variable to be updated with the object's text alignment */

Gets the text alignment of an annotation.

Parameter

Description

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

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function gets the text alignment of those annotation objects (text, note, or text pointer) that display text.

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.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Annotation Functions: Creating and Deleting Annotations

 

Implementing Annotations

 

Annotation Functions: Implementing Custom Annotations

Example

// Sample for

LAnnAutomation::SetTextAlign, LAnnAutomation::GetTextAlign

// This example

changes the text alignment of a text, note, or text pointer annotation

object

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