LAnnAutomation::GetTextRTF

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetTextRTF(uFormat, pText, puLen)

L_UINT uFormat;

text format type

L_TCHAR *pText;

address of character string to be updated

L_SIZE_T *puLen;

address of a variable to be updated

Gets the text and text length (unformatted text or rich text) of an ANNOBJECT_RTF or ANNOBJECT_AUTOMATION annotation object.

Parameter Description
uFormat Value that specifies the text format type. Possible values are:
  Value Meaning
  RTFFORMAT_TEXT [0x0001] Retrieve the text as unformatted text.
  RTFFORMAT_RTF [0x0002] Retrieve the text as rich text.
pText Pointer to a character string to be updated with the annotation object's character string. This value can be NULL.
puLen Address of the variable to be updated with the length of the object's character string.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function is used to retrieve the text from an ANNOBJECT_RTF or ANNOBJECT_AUTOMATION object. The text can be retrieved either as rich text, or unformatted text.

Call this function twice. On the first call, pass NULL for the pText argument to get length of the required input buffer. Then, allocate a buffer and call the function a second time to retreive the text. The following code snippet illustrates the process:

LAnnAutomation lAutomation; // assume this is a valid ANNOBJECT_RTF object  
L_UINT uLength;  
L_TCHAR *pText;  
  
// Get the length  
lAutomation .GetTextRTF(RTFFORMAT_RTF, NULL, &uLength); 
  
// Allocate a buffer  
pText = (L_TCHAR )malloc((uLength+1)*sizeof(L_TCHAR)); 
  
// Retrieve the text  
lAutomation .GetTextRTF(RTFFORMAT_RTF, pText, &uLength);

To get or set the text of other text objects, see the documentation for LAnnAutomation::GetTextLen, LAnnAutomation::GetText and LAnnAutomation::SetText.

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

 

Fixed Annotations

 

Minimizing Flicker With Double Buffering

 

Annotation Functions: Working with the Toolbar

Example

// This sample gets the text from Rich Text annotation object in one of two formats (text, or rich text) // plAutomation: the Rich Text annotation object // uFormat: the format of the retrieved text--one of // RTFFORMAT_TEXT //RTFFORMAT_RTF 
L_INT LAnnAutomation_GetTextRTFExample(LAnnAutomation *plAutomation, L_UINT uFormat) 
{ 
   L_SIZE_T uLength; 
   L_TCHAR *pText; 
   L_TCHAR szMsg[200]; 
   L_TCHAR *pszFormat; 
   L_INT nRet; 
   switch(uFormat) 
   { 
      case RTFFORMAT_TEXT: 
      pszFormat = TEXT("RTFFORMAT_TEXT"); 
      break; 
      case RTFFORMAT_RTF: 
      pszFormat = TEXT("RTFFORMAT_RTF"); 
      break; 
default: 
      return 0; 
      break; 
   } 
   // Get the length 
   nRet = plAutomation->GetTextRTF( uFormat, NULL, &uLength); 
   if (nRet != SUCCESS) 
      return nRet; 
   pText = (L_TCHAR *)malloc((uLength+1)*sizeof(L_TCHAR)); 
   nRet = plAutomation->GetTextRTF( uFormat, pText, &uLength); 
   if (nRet == SUCCESS) 
   { 
      wsprintf(szMsg, TEXT("Format: %s\nLength: %d"), pszFormat, uLength); 
      MessageBox(NULL, pText, szMsg, MB_OK); 
   } 
   else 
      return nRet; 
   free(pText); 
   return SUCCESS; 
}

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C++ Class Library Help
Introduction
Version History
Getting Started
LEADTOOLS Raster Imaging Features
Redistributables/Files To Be Included With Your Application
Quick Reference
Tutorials
Classes and Member Functions
Call Back Functions
Summary of Features