L_AnnSetNameOptions - Raster Imaging C API Help

L_AnnSetNameOptions

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetNameOptions(hObject, pNameOptions, uFlags)

HANNOBJECT hObject;

handle to the annotation object

pANNNAMEOPTIONS pNameOptions;

pointer to a structure that specifies name options

L_UINT uFlags;

flags that determine which objects to process

Sets the options for the annotation object.

Parameter Description
hObject Handle to the annotation object.
pNameOptions Pointer to an ANNNAMEOPTIONS structure that specifies the name options to set.
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 L_AnnGetSelected and L_AnnSetSelected 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

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Use this function to set the name options of any annotation object. To use this function, declare a variable of type ANNNAMEOPTIONS, and pass the address of this variable for pNameOptions. For more information, refer to the documentation for the structure ANNNAMEOPTIONS.

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:

L_AnnSetPredefinedMetafile, L_AnnGetPredefinedMetafile, L_AnnSetMetafile, L_AnnGetNameOptions, L_ScrambleBitmap, L_AnnGetEncryptOptions, L_AnnSetEncryptOptions, L_AnnEncryptApply, L_AnnGetSecondaryMetafile, L_AnnGetPredefinedBitmap, L_AnnSetPredefinedBitmap, L_AnnGetPointOptions

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Altering Annotation Object Settings

Example

This sample enumerates all objects in a container, changing the object name and making it display. If the object is a button, the name is restricted to appear within the bitmap bounds. If the object is not a button, the name is not restricted.

L_INT EXT_CALLBACK annSetNameCallback(HANNOBJECT   hObject, 
                                      L_VOID*       pUserData) 
{ 
   UNREFERENCED_PARAMETER(pUserData); 
   L_TCHAR*       pszOldName; 
   L_TCHAR*       pszNewName; 
   L_UINT         uObjectType; 
   L_TCHAR        szMsg[200]; 
   ANNNAMEOPTIONS NameOptions; 
 
   memset(&NameOptions, 0, sizeof(ANNNAMEOPTIONS)); 
   NameOptions.uStructSize = sizeof(ANNNAMEOPTIONS); 
   NameOptions.uFlags = ANNNAME_NAME_LENGTH; 
 
   L_AnnGetNameOptions(hObject, &NameOptions, sizeof(ANNNAMEOPTIONS)); 
 
   NameOptions.pszName = (L_TCHAR *)malloc(NameOptions.uNameLen + 1 * sizeof (L_TCHAR) ); 
   pszOldName = NameOptions.pszName; 
 
   NameOptions.uFlags = ANNNAME_NAME; 
   L_AnnGetNameOptions(hObject, &NameOptions, sizeof(ANNNAMEOPTIONS)); 
 
   L_AnnGetType(hObject, &uObjectType); 
   if (ANNOBJECT_BUTTON == uObjectType) 
   { 
      pszNewName = TEXT("Name Restricted"); 
      NameOptions.bNameRestrict = TRUE; 
   } 
   else 
   { 
      pszNewName = TEXT("Name Unrestricted"); 
      NameOptions.bNameRestrict = FALSE; 
   } 
 
   NameOptions.pszName = pszNewName; 
   NameOptions.uFlags = ANNNAME_NAME | ANNNAME_RESTRICT; 
   L_AnnSetNameOptions( hObject, &NameOptions, 0); 
 
   wsprintf(szMsg, TEXT("Old Name = %s\nNew Name = %s\n"), pszOldName, pszNewName); 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   free(pszOldName); 
 
   return SUCCESS; 
} 
 
L_INT SampleAnnSetNameOptionsExample(HANNOBJECT hContainer) 
{ 
   L_INT nRet; 
   nRet = L_AnnEnumerate(hContainer, (ANNENUMCALLBACK)annSetNameCallback, NULL, ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
} 

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help