GetItemType Method (FLOATMENU, MENU, MENUITEM, SUBMENU)


9.0F, PLBCMP GUI Only

 

The GetItemType method returns the type for a specified menu item in a FLOATMENU, MENU, MENUITEM, or SUBMENU object. The method uses the following format:

 

[label]

{object}.GetItemType

GIVING {return} USING [*Key=]{key}

 

Where:

label

Optional. A Program Execution Label.

object

Required. A FLOATMENU, MENU or SUBMENU object from the current item type is retrieved.

return

Required. A Numeric Variable that receives the menu item type.

key

Required. A Character String Variable that specifies the run-time name (RUNNAME property) or a Numeric Variable that specifies the zero-based position of the menu item that is accessed.

Flags Affected: OVER, ZERO

Note the following:

  1. The {return} value is the operating system type information for the {key} menu item that was specified. The type value can be interpreted as follows:

  2.  

    Value

    Keyword

    This type indicates that the …

    0xFFFFFFFF

    MFT_END

    menu item specified by {key} was not found.

    0x0

    MFT_STRING

    menu item using a text string. This type is mutually exclusive from the MFT_BITMAP and MFT_SEPARATOR types.

    0x20

    MFT_MENUBARBREAK

    menu item is placed on a new line (for a menu bar) or in a new column (for a drop-down menu or submenu). For a drop-down menu or submenu, a vertical line separates the new column from the old.

    0x40

    MFT_MENUBREAK

    menu item is placed on a new line (for a menu bar) or in a new column (for a drop-down menu or submenu).

    0x800

    MFT_SEPARATOR

    menu item is a separator. This type is mutually exclusive from the MFT_BITMAP and MFT_STRING types.

    0x2000

    MFT_RIGHTORDER

    menus cascade right-to-left. The default is left-to-right

     

  3. The ZERO flag is set if the value returned is zero.

  4. The OVER flag is set if the size of the {return} variable is too small for the value being stored.

 

 

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

 



PL/B Language Reference GetItemState Method (FLOATMENU, MENU, SUBMENU) RemoveItem Method (FLOATMENU, MENU, SUBMENU)