LAnnAutomation::GetTextRotate

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetTextRotate(puTextRotate)

L_UINT *puTextRotate;

/* address of variable to be updated */

Gets a value that indicates whether the text of an annotation object is rotated.

Parameter

Description

puTextRotate

Address of the variable to be updated with a value that indicates whether the text is rotated, and if so, by how many degrees. Possible values are:

 

Value

Meaning

 

TEXTROTATE_0

[0] Do not rotate the text.

 

TEXTROTATE_90

[90] The text is rotated 90 degrees counter clockwise.

 

TEXTROTATE_180

[180] The text is rotated 180 degrees counter clockwise.

 

TEXTROTATE_270

[270] The text is rotated 270 degrees counter clockwise.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function gets a value that indicates whether the text of certain annotation objects that display text will be rotated. The following annotation objects can display rotated text:

ANNOBJECT_AUTOMATION

ANNOBJECT_NOTE

ANNOBJECT_TEXTPOINTER

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

 

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

Example

// Sample for

LAnnAutomation::SetTextRotate, LAnnAutomation::GetTextRotate

// This example

changes the text rotation of a note or text pointer annotation

L_INT LAnnAutomation_GetTextRotateExample(LAnnAutomation *pLAutomation) 
{
   L_INT nRet;
   L_UINT uTextRotate; 
 
   L_TCHAR szMsg[100]; 
 
   L_UINT uType; 
 
   nRet = pLAutomation->GetTextRotate(&uTextRotate); 
   if(nRet != SUCCESS)
      return nRet;
   switch(uTextRotate) 
 
   {
      case TEXTROTATE_0: 
         uTextRotate = TEXTROTATE_90; 
      break; 
 
      case TEXTROTATE_90: 
         uTextRotate = TEXTROTATE_180; 
      break; 
 
      case TEXTROTATE_180: 
         uTextRotate = TEXTROTATE_270; 
      break; 
 
      case TEXTROTATE_270: 
         uTextRotate = TEXTROTATE_0; 
      break; 
 
   }
   nRet= pLAutomation->SetTextRotate(uTextRotate, 0); 
   if (nRet != SUCCESS) 
 
   {
      uType = pLAutomation->GetType();
      wsprintf(szMsg, TEXT(" LAnnAutomation::SetTextRotate Error: %d on object type[%d]\n"), nRet, uType); 
      MessageBox(NULL, szMsg, TEXT("Error"), MB_OK); 
      return nRet;
   }
   return SUCCESS;
}