Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

VI Properties

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

Requires: Base Development System

View the class hierarchy.

You can set these properties for a VI in edit mode by selecting File»VI Properties and other menu items. If you do not wire a refnum to the reference input of the Property Node, LabVIEW gets or sets the property for the current VI.

PropertyDescription
Auto Logging:Log at FinishIndicates whether to write front panel values to a datalog file after the VI runs. Details
Auto Logging:Log File PathPath of the datalog file in which front panel data and a time stamp are written. Details
Auto Logging:Print at FinishIndicates whether to print the front panel after the VI runs. Details
Auto Preallocate Arrays and StringsGet or set the Autopreallocate arrays and strings setting on VIs. This is used by the FPGA module to optimize array and string operations by forcing LabVIEW to preallocate memory at compile time rather than dynamically allocating memory at run time. This property is similar to the Autopreallocate arrays and strings checkbox on the Execution Page of the VI Properties dialog box. Details
Automatic Error HandlingIf TRUE, enables automatic error handling for a VI. Details
Block DiagramReturns a reference to the block diagram of the VI. This property is not available in stand-alone applications. Details
Block Diagram Window:OpenOpens or closes the block diagram window. Details
Block Diagram Window:OriginGets or sets the vertical and horizontal coordinates in the upper left-hand corner of the block diagram. Details
Block Diagram Window:StateCurrent state of the block diagram window. Details
Block Diagram Window:Window BoundsGets or sets the bounds for a block diagram window. Details
Callers' NamesReturns a list of all the loaded VIs that call the referenced VI. Details
Compiled:Code ComplexityReturns the complexity of the referenced VI in relation to the Compiler optimizations slider on the Environment page of the Options dialog box. By comparing these two values, you can determine whether LabVIEW prioritizes editor responsiveness or execution speed when compiling this VI. Details
Compiled:Last Compiled WithReturns the level of compiler optimizations that LabVIEW last used to compile this VI. The value corresponds to whether the complexity of the VI was greater or less than the threshold at which LabVIEW begins limiting compiler optimizations to prioritize editor responsiveness. Details
Connector Pane:DataTypeReturns the data type of the connector pane as variant data. Connector panes for VIs have a VI data type. Connector panes for polymorphic VIs have a PolyVI data type. Connector panes for custom controls, global variables, and type definitions have the data type of the control. Details
Connector Pane:ReferenceReturns a reference to the connector pane of the VI. Details
Connector Pane:SetSets the connector pane of the VI to match the connector pane of the VI reference input. Details
Contains Compiled CodeSets or returns whether the VI includes compiled code. Details
Control VI TypeSpecifies whether a control VI is a control, a typedef, or a strict typedef. This property is valid for control VIs only. Details
Edit Mode On OpenIf TRUE, the VI opens in edit mode. If FALSE, the VI opens in run mode, and the title bar, menu bar, and toolbar do not appear. Details
Execution:Allow DebuggingIf TRUE, you can use debugging tools on the VI. For example, you can set breakpoints, create probes, enable execution highlighting, and single-step through execution. Set this property to FALSE to disable use of debugging tools, reduce memory requirements, and to improve performance slightly for the VI. Details
Execution:Close After CallIndicates whether to close the front panel after the VI runs. Details
Execution:Inline Is AllowedReturns TRUE if you can inline this subVI into its calling VIs. Details
Execution:Inline SubVISpecifies whether to inline the subVI into its calling VIs. Details
Execution:Is ReentrantIndicates whether a VI can be reentrant. Details
Execution:Preferred Exec SystemIndicates the execution system in which the VI runs. Details
Execution:PriorityIndicates the priority of the VI when it runs in parallel with other tasks. Details
Execution:Reentrancy TypeIndicates the type of reentrancy LabVIEW uses for a reentrant VI. Details
Execution:Run When OpenedIndicates whether to run the VI when it opens. Details
Execution:Show Front Panel On CallIndicates whether to show the front panel when the VI is called. Details
Execution:Show Front Panel On LoadIndicates whether to show the front panel when the VI is loaded. Details
Execution:StateIndicates the execution state of the VI. Details
Execution:Suspend On CallIndicates whether LabVIEW suspends the execution of the VI when calling it as a subVI. Use this property carefully with reentrant VIs. Details
Expand When Dropped As SubVIExpands to show terminals when dropped as a subVI. Details
Front PanelReference to the front panel of a VI. Details
Front Panel Window:Allow Runtime PopUpIndicates whether to display shortcut menus for front panel objects while the VI runs. If you do not display default run-time shortcut menus, you can continue to include customized shortcut menus. Details
Front Panel Window:BehaviorSets the behavior of the front panel window. Valid values include 0 (Invalid), 1 (Default), 2 (Floating), 3 (Floating/Auto-Hide), and 4 (Modal). Details
Front Panel Window:CloseableIndicates whether the close button in the title bar is disabled and the Close item in the File menu is disabled. Details
Front Panel Window:Custom TitleIndicates whether the VI has a custom title string. Write FALSE to remove the custom title string. Details
Front Panel Window:Highlight Return ButtonIndicates whether to highlight Boolean controls that have a shortcut key of <Enter>. Details
Front Panel Window:Is FrontmostWriting TRUE to this value brings the front panel to the front. This property applies only in the application instance of the calling VI. Writing FALSE to this value has no effect. If you read this property, it indicates whether the front panel window is the front window (ignoring floating windows). Details
Front Panel Window:Keep Window ProportionsIndicates whether the front panel window adjusts its size in proportion with a change in monitor resolution. The window changes size so it covers the same percentage of the screen that it covered at its original resolution. Details
Front Panel Window:MinimizableIndicates whether the user can minimize the front panel window while the VI runs. Details
Front Panel Window:Minimum SizeMinimum size of the front panel window in pixels. If Front Panel Window:Resizable is TRUE, the user cannot resize the front panel smaller than the width and height you wire to this property. Details
Front Panel Window:MonitorThe monitor on which the front panel window appears, if you have multiple monitors. (Windows) The value 0 is the primary monitor. (OS X) The value 1 is the primary monitor. Details
Front Panel Window:Panel BoundsThe four elements in the cluster are the top, left, bottom, and right values of the interior portion of the front panel, not including the scroll bars, title bar, menu bar, and toolbar. The cluster elements are in global screen coordinates, which are the numbers that refer to coordinates within a computer monitor's screen (rather than an open window). You can set this property only for VIs with open front panels. If you do not want the VI for which you want to set this property to appear to users, use the Hidden state of the Front Panel Window:State property to hide the front panel of the VI. Details
Front Panel Window:ResizableIndicates whether the user can resize the front panel window while the VI runs. Details
Front Panel Window:Run VI TransparentlySets the VI to use a semi-transparent window style when running. Set the level of transparency using the Front Panel Window:Transparency property. Details
Front Panel Window:Show Menu BarIndicates whether to display the menu bar on the front panel while the VI runs. Details
Front Panel Window:StateCurrent state of the front panel window. Details
Front Panel Window:TitleString that appears in the title bar. This string does not have to match the VI filename. Details
Front Panel Window:Title Bar VisibleIndicates whether to display a title bar on the front panel while the VI runs. Details
Front Panel Window:TransparencySets the window transparency level of the VI. The level of transparency is a percentage where 0 is opaque and 100 is invisible. This property returns an error if you specify a value outside the range of 0 to 100. If you set the transparency level to 100, the VI becomes invisible and uncontrollable from the front panel. You must stop the VI on the block diagram for the front panel of the VI to become visible. You must set the Front Panel Window:Run VI Transparently property to TRUE for this property to have any effect. The default value for the Front Panel Window:Run VI Transparently property is FALSE, in which changing this property has no effect. Details
Front Panel Window:Window BoundsThe four elements in the cluster are the top, left, bottom, and right values of the front panel window, which includes the interior region, scroll bars, title bar, menu bar, and toolbar. They are in global screen coordinates, that is, the numbers refer to coordinates within a computer monitor's screen (rather than an open window). You can set this property only for VIs with open front panels. If you do not want the VI for which you want to set this property to appear to users, use the Hidden state of the Front Panel Window:State Property to hide the front panel of the VI. Details
Help:Document PathPath or symbolic path to an HTML file (.htm or .html) or compiled help file (.chm or .hlp) to which the VI is linked. Details
Help:Document TagIndex keyword or HTML filename for a topic in the compiled help file to which the VI is linked. Details
History:Always Add Comments At SaveIndicates whether to add a comment to the VI revision history every time the VI is saved. Details
History:Entire TextReturns all the text that was added to the VI revision history. Details
History:Prompt for Comments At CloseIndicates whether to prompt for a VI revision history comment when the VI closes. Details
History:Prompt for Comments At SaveIndicates whether to prompt for a VI revision history comment when the VI is saved. Details
History:Record Application CommentsIndicates whether to add comments to the VI revision history when certain events occur, such as conversion to a new version of LabVIEW, subVI changes, and changes to the name or path of the VI. Details
History:Revision NumberCurrent revision number of the VI. Details
History:Use DefaultsIndicates whether to use the global default history or to use the values entered in other history properties. Details
Is Clone VIReturns TRUE if the VI is a clone of a reentrant VI. Details
Is In Packed LibraryReturns TRUE if a packed project library contains the VI. Details
Is InstanceReturns whether or not the VI is an Express VI instance. Details
Is ProbeReturns TRUE if the VI is running as a probe and the probe VI is open. Details
Is VI Paused?Specifies whether the execution of the VI is paused. A TRUE value indicates that the VI is paused. A FALSE value indicates that the VI is not paused or that it is not running. Details
LibraryReturns the name of the LabVIEW project library, XControl, or LabVIEW class that owns the VI. If no library, XControl, or class owns the VI, the property returns Not a Refnum. Details
Library:VersionReturns the version of the library that contains the VI you specify. Details
Metrics:Block Diagram LoadedSpecifies whether the block diagram of the VI is in memory. The block diagram can be in memory even if the window is not open. Details
Metrics:Code SizeAmount of memory used for VI code in bytes. Details
Metrics:Front Panel LoadedSpecifies whether the front panel of the VI is in memory. The front panel can be in memory even if the window is not open. Details
Metrics:Size of Block DiagramSize of the block diagram in bytes. Details
Metrics:Size of Front PanelSize of the front panel in bytes. Details
Metrics:Total Data SizeAmount of memory allocated for data in bytes. Details
Modifications:Block Diagram Mods BitsetIndicates whether changes were made to the block diagram since the VI was saved or opened, depending on which was last. If the value is zero, no changes were made. If the value is nonzero, changes were made. Details
Modifications:Front Panel Mods BitsetIndicates whether changes were made to the front panel since the VI was saved. If the value is zero, no changes where made. If the value is nonzero, changes were made. Details
Modifications:VI Modifications BitsetIndicates if changes were made to the VI since the VI was saved. If the value is zero, no changes were made. If the value is nonzero, changes were made. Details
Owning ApplicationReturns a reference to the application that owns the VI. Be sure and close this reference afterward. Details
Printing:Block Diagram Scaling?If TRUE, LabVIEW scales the block diagram to fit on the printed page. Details
Printing:Front Panel Scaling?If TRUE, LabVIEW scales the front panel to fit on the printed page. Details
Printing:Header Content:Date Printed?If TRUE, LabVIEW includes the date printed in the headers for the VI. Use the Printing:Page Headers? property to set whether LabVIEW prints the headers for the VI. Details
Printing:Header Content:Modify Date?If TRUE, LabVIEW includes the last modified date in the headers for the VI. Use the Printing:Page Headers? property to set whether LabVIEW prints the headers for the VI. Details
Printing:Header Content:Page Number?If TRUE, LabVIEW includes the page number in the headers for the VI. Use the Printing:Page Headers? property to set whether LabVIEW prints the headers for the VI. Details
Printing:Header Content:VI Icon?If TRUE, LabVIEW includes the VI icon in the headers for the VI. Use the Printing:Page Headers? property to set whether LabVIEW prints the headers for the VI. Details
Printing:Header Content:VI Name?If TRUE, LabVIEW includes the VI name in the headers for the VI. Use the Printing:Page Headers? property to set whether LabVIEW prints the headers for the VI. Details
Printing:Header Content:VI Path?If TRUE, LabVIEW includes the VI path in the headers for the VI. Use the Printing:Page Headers? property to set whether LabVIEW prints the headers for the VI. Details
Printing:MarginsGets or sets the page margins to use when printing the VI in inches or centimeters. Details
Printing:Page Headers?If TRUE, LabVIEW prints headers for the VI. Use the Printing:Header Content properties in this class to customize the contents of the headers. Details
Printing:Page OrientationGets or sets the page orientation to use when printing the VI. Details
Run-Time Menu PathWhen read, this property returns the run-time menu path of the VI. When written, this property updates the run-time menu path of the VI. If the VI is running when you write this property, it updates the menu with data from the new path. Details
Terminal Bounds[]Returns an array of terminal bounds for the connector pane of the referenced VI. The bounds for each terminal are represented as a cluster of integers that indicate the position of each edge of the terminal rectangle. Details
Tool Bar:Show Abort ButtonIndicates whether to display the Abort Execution button on the toolbar while the VI runs. Details
Tool Bar:Show Free Run ButtonIndicates whether to display the Run Continuously button on the toolbar while the VI runs. Details
Tool Bar:Show Run ButtonIndicates whether to display the Run button on the toolbar while the VI runs. Details
Tool Bar:VisibleIndicates whether to display the toolbar while the VI runs. Details
VI Clone NameName of the clone of a reentrant VI. Returns an error if the VI is not a clone. Details
VI DescriptionDescription of the VI that appears in the Context Help window when you move the cursor over the VI icon and in VI documentation you generate. Details
VI NameName of the VI file. If a LabVIEW project library owns the VI, the property returns the qualified name of the VI, which includes the project library filename. Details
VI PathPath to the VI file. Details
VI TypeIndicates the type of VI. Details

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit