Enumerates the subelements of a project element. This function can be run even if the element is not opened.
In a loop, this function can be used to enumerate the controls found in a window (or in a page) of a project.
Remark: This function cannot be used on the reports or on the queries.
Syntax
<Result> = EnumSubElement(<Element> [, <Option>])
<Result>: Character string
- Full name of the element found (<Window/Page name>.<Control name> for example),
- Empty string ("") if no element was found.
<Element>: Character string
Full name of element to enumerate. For a control, this parameter has the following format: <Window/Page name>.<Control name> ("MyWindow.MyTable" for example).
<Option>: Optional constant
Parameter that must be specified during the first call to the function (to start the enumeration). This parameter is not required to continue the enumeration. | |
| enumContextMenu | Enumerates the popup menus found in a window.
|
| enumFirst | Starts the enumeration |
| enumGroup | Enumerates the groups found in a window or in a page |
| enumMainMenu | Enumerates the drop-down menus found in a window. You can also use EnumMenu. |
| enumPane | Enumerates the panes in a Tab or Ribbon control.
|
| enumSideBar | Enumerates the panes found in a sidebar.
|
Caution: to start the navigation, use the following combinations:- enumFirst to enumerate the controls found in a window or in a page.
- enumFirst + enumGroup to enumerate the groups in a window or page.
- enumFirst + enumPane to enumerate the panes in a Tab or Ribbon control.
- enumFirst + enumContextMenu to enumerate context menus.
- enumFirst + enumSideBar to enumerate the panes in a Sidebar control.
- enumFirst + enumMainMenu to enumerate the main menus of a window or page.
Remarks
This function cannot be used to enumerate the sub-elements of an element found in a component.
Business / UI classification: Neutral code