In This Topic ▼

L_AnnSetAutoMenuEnable

Summary

Enables or disables the automated annotation menus, which appear when the user clicks the right mouse button.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetAutoMenuEnable(hObject, fEnable)

Parameters

HANNOBJECT hObject

Handle to an annotation automation object.

L_BOOL fEnable

Flag that indicates whether to enable or disable the automated annotation menus. Possible values are:

Value	Meaning
TRUE	Enable the automated annotation menus.
FALSE	Disable the automated annotation menus.

Returns

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

Comments

You can disable the context-sensitive automated menus if you want to change the annotation behavior in automation mode. However, this is not necessary if you only want to change the menu text. For changing the text, refer to L_AnnSetAutoText.

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

L_INT AnnSetAutoMenuEnableExample(HANNOBJECT hAutomation) 
{ 
   L_INT nRet; 
   L_BOOL fEnable; 
 
   /* Are menus enabled? */ 
   nRet = L_AnnGetAutoMenuEnable(hAutomation, &fEnable); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   if (fEnable == L_FALSE) 
   { 
      _tprintf(_T("%s"), TEXT("Notice: Menus are disabled. They will be enabled.")); 
      nRet = L_AnnSetAutoMenuEnable(hAutomation, L_TRUE); 
      if (nRet != SUCCESS) 
         return nRet; 
   } 
   else 
   { 
      _tprintf(_T("%s"), TEXT("Notice: Menus are enabled. They will be disabled.")); 
      nRet = L_AnnSetAutoMenuEnable(hAutomation, L_FALSE); 
      if (nRet != SUCCESS) 
         return nRet; 
   } 
 
   return SUCCESS; 
}