MenuSetItemChecked Method

Description

Sets the Checked attribute of the specified menu item on the specified menu.

Syntax

Visual Basic
Public Sub MenuSetItemChecked( _ ByVal Menu As enumMenu, _ ByVal Tool As enumIXTool, _ ByVal TopMenuID As Long, _ ByVal SubMenuID As Long, _ ByVal bChecked As Boolean, _ ByVal bExclusive As Boolean _ )

Visual Basic

Public Sub MenuSetItemChecked( _
   ByVal Menu As enumMenu, _
   ByVal Tool As enumIXTool, _
   ByVal TopMenuID As Long, _
   ByVal SubMenuID As Long, _
   ByVal bChecked As Boolean, _
   ByVal bExclusive As Boolean _
)

Parameters

Menu

Value	Description
Menu_Context	Context menu activated.
Menu_Toolbar	Toolbar menu activated.

When menu type is Menu_Toolbar, then the tool parameter is the Tool ID associated with the menu.

When menu type is Menu_Context, then the tool parameter has no meaning and can be any value.

Tool

Value	Description
TOOL_Hand	Image panning tool.
TOOL_Mag	Magnifying window.
TOOL_MouseWheelHorizScroll	Mouse wheel horizontal scroll.
TOOL_MouseWheelVertScroll	Mouse wheel vertical scroll.
TOOL_MouseWheelZoom	Mouse wheel zoom.
TOOL_None	No tool selected.
TOOL_Pan	Image viewing pan tool.
TOOL_Select	Rubberband window selection tool.
TOOL_ZoomIn	Zoom in tool.
TOOL_ZoomOut	Zoom out tool.
TOOL_ZoomRect	Zoom rectangle tool.

An enumIXtool enumeration.

TopMenuID

Top-level menu ID.

SubMenuID

Sub-level menu ID. If the menu item is to be a top-level menu item then the subMenuID should be 0.

bChecked

Indicates whether the menu item is checked.

bExclusive

If True, and bChecked is True, then the method disables all other items on the same menu level.

Remarks

A menu ID of 4100-4200 is reserved for menu separator bars and will not have a enabled state.

Indicates whether the menu item should have a check-mark visible next to the item. If the item is specified to be checked and exclusive, all other items on the same menu level are unchecked.

Note: The Toolbar must be activated before any context menus can be modified.