L_AnnSetAutoMenuEnable

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetAutoMenuEnable(hObject, fEnable)

HANNOBJECT hObject;

/* handle to an annotation automation object */

L_BOOL fEnable;

/* flag that indicates whether to enable or disable the menus */

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

Parameter

Description

hObject

Handle to an annotation automation object.

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

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.

See Also

Functions:

L_AnnGetAutoMenuEnable, L_AnnSetAutoDrawEnable, L_AnnGetAutoDrawEnable, L_AnnSetAutoText, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor

Topics:

Annotation Functions: Implementing Automation

 

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Annotation Objects - Automated Features

 

Automated User Interface for Annotations

 

Implementing an Automated Annotation Program

 

Altering Annotation Object Settings

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 == FALSE)
   {
      MessageBox (NULL, TEXT("Menus are disabled. They will be enabled."), TEXT("Notice"), MB_OK);
      nRet = L_AnnSetAutoMenuEnable(hAutomation, TRUE);
      if(nRet != SUCCESS)
         return nRet;
   }
   else
   {
      MessageBox(NULL, TEXT("Menus are enabled. They will be disabled."), TEXT("Notice"), MB_OK);
      nRet = L_AnnSetAutoMenuEnable(hAutomation, FALSE);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}