L_AnnGetTextExpandTokens

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetTextExpandTokens(hObject, pbTextExpandTokens)

Gets a value that indicates whether the annotation object's text tokens will expand.

Parameters

HANNOBJECT hObject

Handle to the annotation object

L_BOOL *pbTextExpandTokens

Address of the variable to be updated with the object's text expand token property. Possible values are:

Value Meaning
TRUE Text tokens will be expanded for this object.
FALSE Text tokens will not be expanded for this object.

Returns

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

Comments

This function gets a value that indicates whether the text tokens will be expanded for certain annotation objects that display text. The function is valid only for the following annotation objects:

Calling this function on an object other than one listed above will return ERROR_FEATURE_NOT_SUPPORTED.

If pbTextExpandTokens is updated with TRUE, then all tokens will be expanded.

For example, if you have an ANNOBJECT_BUTTON object that will expand text tokens, and #D is defined to be the current day of the week (ANNTOKEN_DATE_DAY_OF_WEEK), then entering #D for the text of this button will cause it to display the current day of the week when in design or run mode.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

This sample toggles the 'text token expand' property of an annotation.

L_INT AnnGetTextExpandTokensExample(HANNOBJECT hObject) 
{ 
   L_BOOL   bTextExpandTokens; 
   L_INT    nRet; 
   L_TCHAR  szMsg[200]; 
 
   nRet = L_AnnGetTextExpandTokens(hObject, &bTextExpandTokens); 
   if (nRet == SUCCESS) 
   { 
      bTextExpandTokens = !bTextExpandTokens; 
      wsprintf(szMsg, TEXT("Changing text expand tokens property to %s"), 
         bTextExpandTokens ? TEXT("TRUE") : TEXT("FALSE")); 
      MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
      L_AnnSetTextExpandTokens(hObject, bTextExpandTokens, 0); 
   } 
   else 
   { 
      wsprintf(szMsg, TEXT("L_AnnGetTextExpandTokens Failed[%d]"), nRet); 
      MessageBox(NULL, szMsg, TEXT("Error"), MB_OK);  
      return nRet; 
   } 
   return SUCCESS; 
} 

Help Version 20.0.2019.9.22
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help