AAFPopupMenuToString (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

AAF functions

AAFPopupMenuToString (Function)

In french: FAAMenuContextuelVersChaîne

Returns the list of options found in the popup menu actually displayed by the control.

Example

sAll is string = AAFPopupMenuToString(TABLE_NoName1)

FOR EACH STRING sOption OF sAll SEPARATED BY CR
sCaption is string = ExtractString(sOption, 1, TAB)
nID is string = ExtractString(sOption, 2, TAB)
sPos is string = ExtractString(sOption, 3, TAB)
Trace(sCaption + " - " + nID + " - " + sPos)
END

Syntax

<Result> = AAFPopupMenuToString(<Control>)

<Result>: Character string

List of options found in the popup menu of control. This list has the following format:

<Caption 1> + TAB + <Identifier 1> + TAB + <Position 1> + CR + ...
+ CR + <Caption N> + TAB + <Identifier N> + TAB + <Position N>

where:
Caption: Option caption.
Identifier: Option identifier.
Note: This identifier can be used by AAFExecute to run the option directly.
Position: Option subscript in the menu. If the option is found in a sub-menu, this subscript has the following format:

<Number of main option>.<Number of submenu option>

For example, "4.5" for the option 5 of sub-menu 4.

<Control>: Control name

Name of control used.

Remarks

All options found in the popup menu are taken into account:
- Options of system menu.
- Menu options displayed specific to the AAFs (Automatic Application Features).
- Custom options of popup menu.
Only the clickable options are listed.
If the control can display several menus, the last menu displayed is returned.
For example, on a Table control:
- By default, the Table control menu options are listed.
- If the popup menu of a column is displayed, the function will return the options found in the popup menu of the column.

Component : wd240obj.dll