IsScreenOpen
- Last UpdatedOct 29, 2026
- 1 minute read
The function IsScreenOpen that a project screen is open on a client.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
IsScreenOpen |
Module Activity |
Asynchronous |
Yes |
Supported |
Supported |
Not supported |
Supported |
Not supported |
Syntax
IsScreenOpen(strScreen,optNumID)
IsScreenOpen ( strScreen { | ,optNumID } )
strScreen
The name of the project screen to be verified.
optNumID
The specific ID number of the screen. (This number is assigned when the screen is opened using the function Open.)
This parameter is optional; if no value is specified, the default value is 0.
Returned value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
0 |
Screen is not open. |
|
1 |
Screen is open. |
Notes
If the Enforce Web functionality equivalence in local project screens option is selected in the project settings, this function cannot be called in VBScript Global Procedures, VBScript scripts (script groups), or other background tasks. This is because the function behaves differently depending on whether you view project screens locally (that is, on the same computer that hosts the project runtime) or remotely. For more information, see Preferences tab.
Examples
Is the screen named "main" open?
IsScreenOpen("main")
Is the screen named "main" with ID 10 open?
IsScreenOpen("main",10)