group Parameter

Specifies the conditions under which a menu item will be enabled or disabled.

Scope: File

Syntax

set group.[MenuItemId] [GroupName] [GroupName] [...] 

Options

MenuItemId 
The numeric menu item id that can be obtained by the query actionbarid command. The id for the last-defined menu item is used, if zero or no value is specified.
GroupName 
The name of the group to which the MenuItemId is added. Unrecognized group names are ignored. One or more of the following groups can be specified:
BLOCK      CHANGED      ClassName
CLIPBOARD  DOCNONEMPTY  MARKSET
MOREDOCS   MOREVIEWS    SAVEABLE
WRITEABLE 

Description

The group parameter specifies the group(s) to which a menu item belongs. The conditions for each associated group must be satisfied before a menu item is enabled.

For example, the Paste operation belongs to the CLIPBOARD and WRITEABLE groups. It will be enabled only when there is text in the clipboard and the file is not readonly.

The following table lists the states required for each group to be active or inactive:

Group Name Active
Members are Selectable
Inactive
Members are not Selectable
BLOCK
Block is set Block is not set
CHANGED
Change has been made No changes have been made
ClassName 
Other classes are included in the current view Only a specified class is included in the current view
CLIPBOARD
Clipboard contains text Clipboard is empty
DOCNONEMPTY
File contains text File is empty
MARKSET
Mark is set No mark is set
MOREDOCS
More than one file is open Only one file is open
MOREVIEWS
More than one view is open Only one view is open
SAVEABLE
File can be saved File cannot be saved
WRITEABLE
Changes to file permitted Changes to file not permitted

Examples

  1. To specify the last defined menu item to be enabled when text is selected:
    set group.block 
  2. To specify the last defined menu item to be enabled when text in the COMMENTS class is visible:
    set group.comments 

API Return Code

-3 
The specified menu item id does not correspond to any user-defined action.

classes Parameter