In This Topic ▼

LAnnotation::SetTextOptions

Summary

Sets the text options for the annotation object.

Syntax

#include "ltwrappr.h"

L_INT LAnnotation::SetTextOptions(pTextOptions, uFlags)

Parameters

pANNTEXTOPTIONS pTextOptions

Pointer to an ANNTEXTOPTIONS structure that specifies the text options to set.

L_UINT 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.

Returns

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

Comments

Use this function to set the text options of any annotation object that uses text. If the annotation objects are container, automation, text, text pointer, stamp, note, pushpin, or button objects it is possible to use the LAnnotation::GetTextOptions and the LAnnotation::SetTextOptions functions to set the objects to show or hide the text and to set the color of the text. In addition, if the annotation objects are text or stamp objects these functions can set the objects to show or hide the borders of the object. These features must be enabled using the LAnnotation::SetOptions function. To use this function, declare a variable of type ANNTEXTOPTIONS, and pass the address of this variable for pTextOptions. For more information, refer to the documentation for the structure ANNTEXTOPTIONS.

The class object must be one of the following types:

Otherwise ERROR_FEATURE_NOT_SUPPORTED is returned.

Note: Enable this function by calling the LAnnotation::SetOptions function with the OPTIONS_NEW_TEXT_OPTIONS flag set.

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

The following example changes some of the text options of
a text-based annotation. It changes the text color to blue,
and toggles the ShowBorder option.

L_INT LAnnotation_SetTextOptionsExample(LAnnAutomation& automate) 
{ 
 
   L_INT nRet = FAILURE; 
   ANNTEXTOPTIONS TextOptions; 
   L_UINT uOptions = 0; 
   L_TCHAR szMsg[200]; 
 
   nRet = automate.GetOptions(&uOptions); 
   if(nRet != SUCCESS) 
      return nRet; 
   uOptions |= OPTIONS_NEW_TEXT_OPTIONS; 
 
   nRet = automate.SetOptions(uOptions); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   memset(&TextOptions, 0, sizeof(TextOptions)); 
   TextOptions.uStructSize = sizeof(TextOptions); 
   TextOptions.uFlags = ANNTEXT_SHOW_TEXT | ANNTEXT_SHOW_BORDER | ANNTEXT_TEXTCOLOR; 
   nRet = automate.GetTextOptions(&TextOptions, sizeof(TextOptions)); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   wsprintf(szMsg, TEXT("Old Options: ShowText[%d], ShowBorder[%d], TextColor[0x%x]"), 
            TextOptions.bShowText, 
            TextOptions.bShowBorder, 
            TextOptions.crText); 
 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   // Change some options 
 
   TextOptions.bShowBorder = !TextOptions.bShowBorder; 
   TextOptions.crText = RGB(0,0,255); 
   TextOptions.uFlags = ANNTEXT_SHOW_BORDER | ANNTEXT_TEXTCOLOR; 
 
   nRet = automate.SetTextOptions(&TextOptions, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   memset(&TextOptions, 0, sizeof(TextOptions)); 
   TextOptions.uStructSize = sizeof(TextOptions); 
   TextOptions.uFlags = ANNTEXT_SHOW_TEXT | ANNTEXT_SHOW_BORDER | ANNTEXT_TEXTCOLOR; 
 
   nRet = automate.GetTextOptions(&TextOptions, sizeof(TextOptions)); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   wsprintf(szMsg, TEXT("New Options: ShowText[%d],  ShowBorder[%d], TextColor[0x%x]"), 
            TextOptions.bShowText, 
            TextOptions.bShowBorder, 
            TextOptions.crText); 
 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   return SUCCESS; 
}