18.01.2015 Views

Technical Reference Manual - InduSoft

Technical Reference Manual - InduSoft

Technical Reference Manual - InduSoft

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Appendix: Built-in Scripting Language<br />

Screen functions<br />

These functions are used to open and close project screens.<br />

Close<br />

Close is a built-in scripting function that closes an open project screen.<br />

Function Group Execution Windows Embedded Thin Client<br />

Close Screen Asynchronous Supported Supported Supported<br />

Syntax<br />

Close(strScreen{ | ,optNumID })<br />

strScreen<br />

optNumID<br />

The name of the screen (not including the .scr extension) to be closed.<br />

Note: Some Web servers are case-sensitive. If you plan to deploy your project<br />

as a Web application, then you should use only lowercase letters for the screen<br />

name.<br />

The specific ID or instance number of the screen to be closed, if there is more than one screen<br />

with the same name open. (The ID is assigned when the screen is opened with the Open<br />

function.)<br />

This is an optional parameter. If no value is specified, then the default ID is 0.<br />

Returned value<br />

This function does not return any value.<br />

Notes<br />

This function cannot be used with Tasks or in the Global Procedures script.<br />

Also, in some cases, you do not need to call this function to close a screen because the screen will be closed<br />

automatically when another screen replaces it. For more information, see Screen Attributes.<br />

Examples<br />

Close the screen named "main":<br />

Close( "main" )<br />

Close the screen named "alarms":<br />

Close( "alarms" )<br />

Close the screen named "main" with ID 10:<br />

Close( "main", 10 )<br />

<strong>InduSoft</strong> Web Studio Page 579

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!