Front Panel Window:State Property
Short Name: FP.State
Installed With: Base Package
Class: VI Properties
Current state of the front panel window. Valid values include 0 (Invalid), 1 (Standard), 2 (Closed), 3 (Hidden), 4 (Minimized), and 5 (Maximized).
A state of Standard or Maximized indicates that the front panel window is visible to the user.
If you attempt to set this property for a front panel window that is not open, the property returns an error.
If you load the VI in a subpanel control, this property is read only and always returns a value of Hidden.
You also can use the Front Panel:Open method to set the state of the front panel window when you display it.
Values
0 | Invalid—If you read this property and an error occurs, the property returns this value. If you set the property to this value, the property returns an error. |
1 | Standard—The front panel window is open but is not minimized, maximized, or hidden. |
2 | Closed—The front panel window is not open. If you set the property to this value, the property returns an error. |
3 | Hidden—The front panel window is hidden. If you set the property to this value and close all references to the front panel, the window remains open but hidden. Because the VI is open, the Getting Started window does not appear. To solve this problem, open the VI from the operating system. For example, double-click the VI in Windows Explorer to open the VI. |
4 | Minimized—The front panel window is minimized. |
5 | Maximized—The front panel window is maximized. |
Remarks
The following table lists the characteristics of this property.
Available in Run-Time Engine and Real-Time Operating System | Yes |
Permissions | Read/Write |
Settable when the VI is running | Yes |
Loads the front panel into memory | No |
Need to authenticate before use | No |
Loads the block diagram into memory | No |
Remote access disallowed | No |
Must wait until user interface is idle | No |
Available with control VIs | Yes |
Available with global VIs | Yes |
Available with strict type definitions | No |
Available with polymorphic VIs | Yes |
Example
Refer to the FrontPanelStates VI in the labview\examples\viserver directory for an example of using the Front Panel Window:State property.