gpwEnumControl (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwEnumControl (Function)

In french: gpwEnumèreChamp

Enumerates the controls found in a window or page.

Remarks:

This function is used by the user groupware to enumerate the controls whose status (invisible, grayed, inactive) can be modified by the user groupware.
This function can be used even if the user groupware is not enabled in the project.

Versions 19 and later

This function is now available for WEBDEV sites in Windows.

New in version 19

This function is now available for WEBDEV sites in Windows.

Example

PROCEDURE EnumChildControl(sParentName is string)

// Browse the controls
nSubscript is int = 1
sNameChildControl is string
sControlInfo is string = gpwEnumControl(sParentName, nSubscript)
WHILE sControlInfo <> ""
Trace(sControlInfo)
// Retrieve the full name of the child control
sNameChildControl = ExtractString(sControlInfo, 1, TAB)
Trace(sNameChildControl)
// Next control
nSubscript++
sControlInfo = gpwEnumControl(sParentName, nSubscript)
END

Syntax

<Result> = gpwEnumControl(<Parent element> , <Subscript>)

<Result>: Character string

Characteristics of control found. These characteristics have the following format:

<Full control name> + TAB + <Full parent name> + TAB + ...
<Type> + TAB + <Plain type> + TAB + <Caption>

where:
<Full control name>: Full name of the control found.
<Full parent name>: Full name of control parent (empty string for a window).
<Type>: identifier of control type (..Type).
<Plain type>: Readable control type (for example, "Button", "Scrollbar", ...).
<Caption>: Control caption.
"" (empty string) if the enumeration is ended.

<Parent element>: Character string with quotes

Name of "parent" object (containing the control). This parameter corresponds to the name of a window, page or report.

<Subscript>: Integer

Subscript of control to enumerate. Each control is associated with a number. This number corresponds to the order in which the controls have been created.

Component : wd260gpu.dll