EnumSubElement (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Project functions

Limit

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EnumElement (Function)

EnumSubElement (Function)

In french: EnumèreSousElément

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.

Note: This function cannot be used on reports or queries.

Example

See additional examples

// Énumération des champs d'une page d'un projet
NomChamp is string = EnumSubElement("MaPage", enumFirst)
// Parcours tous les champs
WHILE NomChamp <> ""
	Trace(NomChamp)
	// Passage au champ suivant
	NomChamp = EnumSubElement("MaPage")
END

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 context menus found in a window.
This constant is not available.
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.
This constant is not available.
enumPane Enumerates the tabs in a Tab or Ribbon control.
This constant is not available.
enumSideBar Enumerates the panes found in a sidebar.
This constant is not available.

Please note: the following combinations must be used to initialize the route:
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 tabs in a Sidebar control.
enumFirst + enumMainMenu to enumerate the main menus of a window or page.

Remarks

Limit

This function cannot be used to enumerate the subelements of an element found in a component.

Business / UI classification: Neutral code

Component: wd300gpu.dll