VI Methods
Installed With: Base Package
View the class hierarchy.
| Method | Description |
|---|---|
| Abort VI | Aborts the VI execution. Details |
| Block Diagram:Clean Up | Cleans up the block diagram of the VI by rearranging and resizing its objects and signals to improve readability. You also can select Edit»Clean Up Diagram to clean up the block diagram. Details |
| Block Diagram:Get Image Scaled | Returns an image of the block diagram and scales it proportionally according to the maximum width and height you wire to the method. For example, if the image of the block diagram is 200 by 200 pixels and you wire a value of 50 to maximum width and a value of 100 to maximum height, this method returns an image that is 50 by 50 pixels. If you do not wire a value to maximum width or maximum height, the image retains its actual size. Details |
| Clear History | Clears the revision history of the referenced VI. Details |
| Control Value:Get All | Gets the values of all controls or indicators in a VI as variant data. This method returns an array of clusters that contains control and indicator names and their values as variant data. Use the Variant to Data function to convert the data to another LabVIEW data type. Details |
| Control Value:Get | Gets the value of a named control or indicator as variant data. Use the Variant to Data function to convert the data to another LabVIEW data type. Details |
| Control Value:Set | Sets the value of a named control or indicator of the variant. You can wire a value of any data type to this method. You do not have to use the To Variant function to convert the data to a variant data type. Details |
| Default Values:Make Current Default | Changes the defaults of all controls on the front panel to be the current values. This method is available only in edit mode. Details |
| Default Values:Reinitialize All To Default | Changes the current values of all controls on the front panel to their defaults. Details |
| Disconnect From Library | Disconnects a VI that a LabVIEW project library owns from the owning project library. Details |
| Find Control with Key Focus | Return a reference to the control that currently has key focus. If there is not a control with key focus in the target VI, Not a Refnum is returned. Details |
| Front Panel:Center | Specifies whether to automatically center the front panel window on the computer screen. Details |
| Front Panel:Close | Closes the front panel window. Details |
| Front Panel:Get Image Scaled | Returns an image of the front panel and scales it proportionally according to the maximum width and height you wire to the method. This method is similar to the Front Panel:Get Image method. Details |
| Front Panel:Get Image | Returns an image of the front panel as a flattened pixmap. Use the Front Panel:Get Image Scaled method to return an image of the front panel and scale it proportionally according to the maximum width and height you wire to the method. Details |
| Front Panel:Open | Opens the front panel window. If the front panel is already open, this method changes the state of the front panel window to the state you wire to this method. Details |
| Front Panel:Run-Time Position:Centered | Sets a VI to center its front panel every time the VI runs. Details |
| Front Panel:Run-Time Position:Custom | Sets a custom position for the VI to move its front panel to every time the VI runs. Details |
| Front Panel:Run-Time Position:Get Position | Returns the position of the run-time window. Details |
| Front Panel:Run-Time Position:Maximized | Sets a VI to maximize its front panel every time the VI runs. Details |
| Front Panel:Run-Time Position:Minimized | Sets a VI to minimize its front panel every time the VI runs. Details |
| Front Panel:Run-Time Position:Unchanged | Sets the VI to not move its front panel when the VI runs. Details |
| Generate C Code Variant | Contains the code generation attributes (name, value pairs) that determine how the LabVIEW C Code Generator generates the C code from the block diagram. Any attributes you do not set use the default behavior. Details |
| Lock State:Get | Returns the lock state of the VI and indicates whether the password for the VI is in the password cache. Details |
| Lock State:Set | Sets the lock state of a VI. If interactive is FALSE (default), you can use password to either unlock a password-protected VI or set the password of an unprotected VI. If interactive is TRUE, LabVIEW ignores password and displays a dialog box that prompts you to change the lock state. Details |
| Print:Panel To Printer | Prints just the front panel to the current printer. You cannot use this method to print a block diagram, list of controls, or polymorphic VI front panel. Details |
| Print:VI To HTML | Saves the VI information to an HTML file and saves the graphics in external files. You can use the Open URL in Default Browser VI to display the HTML file in the default Web browser. Details |
| Print:VI To Printer | Prints the VI information to a printer. Details |
| Print:VI To RTF | Saves the VI information to an RTF file. Details |
| Print:VI To Text | Saves the VI information to a text file. You cannot save the icon, connector pane, front panel, block diagram, subVI icons, and VI hierarchy to text. Details |
| Remote Panel:Client Connections | Returns an array of clusters containing connection information about the clients viewing or controlling the VI. Details |
| Remote Panel:Close Connection To Client | Closes a remote front panel connection to a client. Details |
| Remote Panel:Lock Control | Returns control of the front panel to the server and queues any requests from clients to control the front panel. LabVIEW ignores this method if the front panel is already locked. Details |
| Remote Panel:Unlock Control | If the front panel is locked, this method grants control to the next client in the queue. If no clients are in the queue, the method unlocks the front panel. LabVIEW ignores this method if the front panel is already unlocked. Details |
| Revert VI | Discards changes and reloads a VI from disk. Details |
| Run VI | Starts the VI execution, similar to the Run button. This method is different than calling a VI because it uses the current values of all front panel controls for execution rather than using data passed in through parameters. This method also ignores the Execution:Show Front Panel On Call property of a VI and the Execution:Close After Call property. Details |
| Save:For Previous | Saves a copy of the VI that is readable by LabVIEW version 8.0 and later. Details |
| Save:Instrument | Saves a VI and synchronizes the VI with the edited version in other application instances before saving. Details |
| Save:Run-Time Menu | Saves the run-time menu to a file specified by Path. This method works only when the VI is running. It saves only menu items with valid tags. Details |
| VI Icon:Get As Image Data | Returns the VI icon as a cluster of image data so you can draw it as a picture using the Draw Flattened Pixmap VI or save the image to a file using the Graphics Formats VIs. Details |
| VI Icon:Save To File | Saves an image of the VI icon to a file. Details |
| VI Icon:Set From File | Sets the image of a VI icon from a file. Details |
| VI Icon:Set From Image Data | Sets the image of a VI icon. Details |
| VI Strings:Export | Exports the following strings about VI and front panel objects to a tagged text file: VI name and description, object caption labels, object free labels, default data (string, table, path, and array default data), private data (listbox item names, table row and column headers, graph plot names, graph cursor names, graph annotation names, and tab control page captions), and polymorphic VI data (instance names in the polymorphic VI and selector shortcut menus). Details |
| VI Strings:Import | Imports the following strings about VI and front panel objects from a tagged text file: VI name and description, object caption labels, object free labels, default data (string, table, path, and array default data), private data (listbox item names, table row and column headers, graph plot names, graph cursor names, graph annotation names, and tab control page captions), and polymorphic VI data (instance names in the polymorphic VI and selector shortcut menus). Details |