AddItem Method (FLOATMENU, MENU, SUBMENU)


9.0, PLBCMP GUI Only

 

The AddItem method creates a new menu item in a FLOATMENU, MENU, or SUBMENU object. The method uses the following format:

 

[label]

{object}.AddItem

[GIVING {return}]:

 

 

USING [[*Checked=]{checked}]:

 

 

[*Default=]{default}]:[

 

 

[*Enabled=]{enabled}]:[

 

 

[*ItemPos=]{itempos}]:[

 

 

[*Separator=]{separator}]:[

 

 

[*ShortCut=]{shortcut}]:[

 

 

[*SpcMenu=]{spcmenu}]:[

 

 

[*SubMenu=]{submenu}]:[

 

 

[*Tag=]{tag}]:[

 

 

[*Text=]{text}]:[

 

 

[*RunName=]{runname}][:

 

 

[*HelpId=]{helpid}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A FLOATMENU, MENU or SUBMENU object to which an item is added.

return

Optional. The created MENUITEM object.

checked

Optional. A Numeric Variable or decimal number that specifies the checked flag of the menu item (see the CHECKED property).

default

Optional. A Numeric Variable or decimal number that specifies the default flag of the menu item (see the DEFAULT property).

enabled

Optional. A Numeric Variable or decimal number that specifies the enabled state of the menu item (see the ENABLED property).

itempos

Optional. A Numeric Variable or decimal number that specifies the zero-based insertion position of the menu item.

separator

Optional. A Numeric Variable or decimal number that specifies the separator flag of the menu item (see the SEPARATOR property).

shortcut

Optional. A Numeric Variable or decimal number that specifies the associated short cut key (see the SHORTCUT property).

spcmenu

Optional. A Numeric Variable or decimal number that specifies any special menu action (see the SPECIALMENU property).

submenu

Optional. A submenu object that specifies any associated submenu (see the SUBMENU property).

tag

Optional. A Numeric Variable or decimal number that specifies the tag number of the menu item (see the TAG property).

text

Optional. A Character String Variable or literal that specifies the text displayed on the menu item (see the TEXT property).

runname

Optional. A Character String Variable or literal that specifies the run-time name of the menu item (see the RUNNAME property).

helpid

Optional. A numeric variable or decimal number that specifies the menu item top number as defined in a user generated Windows help file.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. If the value returned is zero, the ZERO Condition Flag is set.

  2. The OVER and EOS Condition Flags are always cleared.

  3. The created MENUITEM can be accessed through the ITEMS collection of the menu.

  4. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

 

 

See Also: Method Syntax, FLOATMENU, MENU, SUBMENU Methods

 



PL/B Language Reference Activate Method (FLOATMENU) GetItem Method (FLOATMENU, MENU, MENUITEM,SUBMENU)