WinStatus (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Functions for managing windows

WinStatus

Presentation

Example

Modal opening/Non-modal opening

Differences between the Invisible and OutsideScreen constants

Inactive or invisible window

Closing the window

See also

WinStatus (Function)

In french: FenEtat

Identifies or modifies the window status.

Remark: WinStatus can also be used to check the existence of a window.

Versions 16 and later

This function is now available for Android applications.

New in version 16

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 19 and later

This function is now available for the WINDEV applications in Linux.

New in version 19

This function is now available for the WINDEV applications in Linux.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

Example

// Identify the status of current window
ResWinStatus = WinStatus()

// Modify the state of a window
SWITCH WinStatus(WIN_WindowName)
CASE Active
WinStatus(WIN_WindowName, Grayed)
CASE NotFound
Open(WIN_WindowName)
END

Syntax

Identifying the window status Hide the details

<Result> = WinStatus([<Window name>])

<Result>: Constant

Current status of window:
Active Active window (window in edit, even if it does not have the focus).
DisplayOnly Inactive window (this window is not in edit).
Grayed The window controls are grayed.
OutsideScreen Active window displayed outside the visible screen area.
This constant is not available.
NotFound Window closed or not found.
Invisible Window invisible on the screen and inactive.

<Window name>: Optional character string (with or without quotes)

Name or alias of window to use.
If this parameter is not specified or if it corresponds to an empty string (""), the status of current window is returned.

Modifying the window status Hide the details

<Result> = WinStatus(<Window name> , <Window status>)

<Result>: Constant

Status after modification:
Active Active window (window in edit).
DisplayOnly Inactive window (this window is not in edit).
Grayed The window controls are grayed.
OutsideScreen Active window displayed outside the visible screen area.
This constant is not available.
NotFound Window closed or not found.
Invisible Window invisible on the screen and inactive.
No window can be made invisible.

<Window name>: Character string (with or without quotes)

Name or alias of window to use.
If this parameter corresponds to an empty string (""), the status of current window is modified.

<Window status>: Constant

Specifies the new status and new positioning of the specified window.
If this parameter corresponds to an empty string (""), the change of position (Above, AboveAll, Normal constant) for a window is canceled.
TopActive The window becomes active (window in edit) and it is displayed in the foreground. This constant corresponds to the result of a click performed in the title bar of window.
This constant is not available.
Active The window becomes active (window in edit).
DisplayOnly The window becomes inactive (no input is allowed in the window controls).
Invisible The window becomes invisible and inactive.
No window can be made invisible.
Grayed The window controls are grayed.
Above The window moves to the foreground in relation to the other application windows.
This constant is not available.
AboveAll The window moves to the foreground in relation to all other windows, even to the ones of the other applications. This constant is ignored for the MDI child windows displayed from a MDI parent window.

This constant is not available.
OutsideScreen The window remains active but is positioned outside the visible screen area.
This constant is not available.
NotFound The window is closed. A WLanguage error occurs if this window does not exist.
Normal A window in AboveAll mode switches to the normal mode (the windows of other applications can be displayed in the foreground). In the other cases, this constant has no effect.
This constant is not available.

Remarks

Modal opening/Non-modal opening

In modal opening (MDI parent window and MDI child window), WinStatus cannot be used:

to make a parent window active.
to display a child window "above" with the Above or AboveAll constant from an MDI parent window.

In modal opening, if a parent window is made invisible, the child window is also made invisible.

In non-modal opening, if a parent window with at least one child window is made invisible, the child windows are not made invisible.

Differences between the Invisible and OutsideScreen constants

If the type of a parent window is:
- OutsideScreen, this window is displayed in the list of Windows applications (accessible via Alt Tab).
- Invisible, this window is not displayed in the list of Windows applications (accessible via Alt + Tab).
The coordinates of an OutsideScreen window are negative.
Switching from:
- Invisible to Active triggers the execution of processes for focus gain and focus loss in an incoherent way.
- OutsideScreen to Active triggers the proper execution of processes for focus gain and focus loss.

Tip: You should use the OutsideScreen status rather than the Invisible status.

If an OutsideScreen window is redisplayed by WinStatus associated with the Active constant, WinStatus does not give focus to the window.
If the OutsideScreen window did not have focus, it does not have focus after the call to WinStatus.

No window can be made invisible.

Inactive or invisible window

If the current window becomes inactive or invisible, the "loss of focus" process of the window will be run before the change of status.

No window can be made invisible.

Closing the window

The following code is used to close the window:

WinStatus(<Window name>, NotFound)

This code is equivalent to Close.

Component : wd260obj.dll