LAnnAutomation::SetTextRTF

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetTextRTF(uFormat, pText, uFlags)

L_UINT uFormat;	/* text format type */
L_TCHAR * pText;	/* pointer to the text
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the text (unformatted text or rich text) of one or more ANNOBJECT_RTF annotation objects. It can also set the rich text of an ANNOBJECT_AUTOMATION object.

Parameter	Description
uFormat	Value that specifies the text format type. Possible values are:
	Value	Meaning
	RTFFORMAT_TEXT	[0x0001] Interpret the text as unformatted text.
	RTFFORMAT_RTF	[0x0002] Interpret the text as rich text.
pText	Character string that contains the text to assign to the annotation object. This can be unformatted text, or rich text. This is a NULL terminated string.
uFlags	Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( \| ). The following are valid values:
	Value	Meaning
	0	Process only the specified object.
	ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
	ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
	ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
	ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.
	ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_TEXT menu item has been selected.

Returns

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

Comments

This function applies to multiple and selected objects based on values of the uFlags parameter.

This function does not affect objects that do not have this property or that do not let you change the property. For descriptions of the various types of objects and their properties, refer to Types of Annotations.

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 loads a rich text annotation object with text

// It illustrates how L_AnnSetTextRTF() can treat the text as Rich Text, or plain text

// hObject: the Rich Text annotation object

// uFormat: the format of the retrieved text--one of

// RTFFORMAT_TEXT

// RTFFORMAT_RTF

#define RICH_STRING TEXT("{\\rtf1\\ansi\\anicpg1252\\deff0\\deflang1033\
                         {\\fonttbl{\\f0\\fnil\\fcharset0 Arial;}}{\\colortbl;\
                          \\red255\\green0\\blue0;\\red255\\green255\\blue255;\
                           \\red51\\green102\\blue0;\\red0\\green0\\blue255;\
                            \\red0\\green0\\blue0;}\\viewkind4\\uc1\\pard\\cf1\
                            \\highlight2\\ul\\fs20 Rich \\cf3\\ulnone\\b Text\
                            \\cf4\\b0\\i String\\cf5\\i0\\par}")
L_INT LAnnAutomation_SetTextRTFExample(LAnnAutomation *plAutomation, L_UINT uFormat) 
{
   L_INT nRet;
   L_TCHAR *pszFormat; 
   L_TCHAR szMsg[200]; 
   switch(uFormat) 
   {
      case RTFFORMAT_TEXT: 
         pszFormat = TEXT("RTFFORMAT_TEXT");
         nRet = plAutomation->SetTextRTF(uFormat, RICH_STRING, 0); 
         if(nRet != SUCCESS)
            return nRet;
 
      break; 
      case RTFFORMAT_RTF:
         pszFormat = TEXT("RTFFORMAT_RTF");
         nRet = plAutomation->SetTextRTF(uFormat, RICH_STRING, 0); 
         if(nRet != SUCCESS)
            return nRet;
 
      break; 
      default: 
         return FAILURE; 
      break; 
   }
   wsprintf(szMsg, TEXT("SetTextRTF returned %d\nFormat: %s"), nRet, pszFormat); 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   return SUCCESS;
}