Skip to Content

Environment

Introduction

The Environment module provides the ability to perform actions based on the current status of the custom module it is contained within. It can also be used to manipulate the window of its parent module.

On Load

The Environment module sends an output message of "true" when a custom module it is contained in is first loaded. This allows a custom module to automatically perform some initial action such as retrieving current ProtoDB or Excel data when it is loaded from a repository.

Opening and Closing Viewer Windows

The Environment module has input connectors that open and close the Viewer window of the custom module it is contained within. This is useful in combination with a custom module with its Viewer presentation set to pop up. For example, a Button module in the same custom module could be connected to the "Close Parent Viewer" input connector to provide a way to close the pop up Viewer window.

Input Menu:

Window Connectors → Open Parent Viewer

Sending input to this connection when the target Viewer is closed will open it. Sending input to this connection when the target Viewer is already open will bring the Viewer to the front.

Accepted Datatypes:
Any
Window Connectors → Close Parent Viewer

Sending input to this connection will close the target Viewer. If it is already closed it will have no effect.

Accepted Datatypes:
Any

Output Menu:

On Load

Fires a message of "true" whenever the custom module is opened.

Output Datatype:
True/false
The value "true".
Triggered By:
Action:
Triggered immediately after the custom module has loaded completely.