In This Topic ▼

L_AnnSetHyperlinkMenuEnable

Summary

Enables or disables the displaying of the hyperlink menu item when you click the right mouse button in design mode.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetHyperlinkMenuEnable (hObject, fEnable, uFlags)

Parameters

HANNOBJECT hObject

Handle to the annotation automation object.

L_BOOL fEnable

Flag that indicates whether to display the hyperlink menu item when you right click in design mode. Possible values are:

Value	Meaning
TRUE	Show the hyperlink menu item when you click the right mouse button in design mode.
FALSE	Do not show the hyperlink menu item.

L_UINT uFlags

Reserved for future use. You can pass 0.

Returns

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

Comments

This function applies only to automation objects.

Set fEnable to TRUE if you want to bring up a dialog box to select the type of hyperlink an object will have. There is no default way to set the hyperlink type. The text in the menu is given by ANNAUTOTEXT_MENU_HYPERLINK (see 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 AnnSetHyperlinkMenuEnableExample(HANNOBJECT hAutoObject /* Automation object */) 
{ 
   L_INT    nRet; 
   L_BOOL   bEnabled; 
 
   /* toggle display of HyperLink menu item */ 
   nRet = L_AnnGetHyperlinkMenuEnable(hAutoObject, &bEnabled); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   if (bEnabled) 
   { 
      /* disable menu item */ 
      nRet = L_AnnSetHyperlinkMenuEnable(hAutoObject, L_FALSE, 0); 
      if (nRet != SUCCESS) 
         return nRet; 
   } 
   else 
   { 
      /* enable menu item */ 
      nRet = L_AnnSetHyperlinkMenuEnable(hAutoObject, L_TRUE, 0); 
      if (nRet != SUCCESS) 
         return nRet; 
   } 
 
   return SUCCESS; 
}