Jump to content

VI class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
Visual
mNo edit summary
Replaced with template table
Tag: Replaced
Line 8: Line 8:


==Properties==
==Properties==
<span class="mw-customtoggle-propertiestable">Show/Hide VI Properties Table</span>
{{VIServerPropsTable|2}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ VI Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|225
| [[VI class/AutoLog.Path property|AutoLog.Path]]
|Path of the datalog file in which front panel data and a time stamp are written.
 
<b>Note</b>  Use this property in conjunction with the Log at Finish property, which specifies whether to log the data. If you set the Log at Finish property without also setting this property, a dialog box appears at run time, prompting you to specify a file path.
|R/W
|X
|- style="background-color:#FFFFCC;"
|226
| [[VI class/AutoLog.AtFinish property|AutoLog.AtFinish]]
|Indicates whether to write front panel values to a datalog file after the VI runs.
 
This method is similar to the <b>Log at Completion</b> item on the Operate menu.
 
<b>Note</b>  If you set Log at Finish without having set the Log File Path property, the next time this VI finishes executing, a dialog box appears prompting you to specify the file path.
|R/W
|X
|- style="background-color:#FFFFCC;"
|227
| [[VI class/AutoLog.PrintAtFinish property|AutoLog.PrintAtFinish]]
|Indicates whether to print the front panel after the VI runs.
 
This method is similar to the <b>Automatically print front panel every time VI completes execution</b> option on the Print Options page of the VI Properties dialog box and the <b>Print at Completion</b> item in the Operate Menu.
|R/W
|X
|- style="background-color:#CCFFFF;"
|283
| [[VI class/AutoPreallocate property|AutoPreallocate]]
|Get or set the <b>Autopreallocate arrays and strings</b> 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 <b>Autopreallocate arrays and strings</b> checkbox on the Execution Page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|242
| [[VI class/Auto Err Handling property|Auto Err Handling]]
|If TRUE, enables automatic error handling for a VI.
 
By default, LabVIEW automatically handles any error that occurs when a VI runs by suspending execution, highlighting the subVI or function where the error occurred, and displaying an error dialog box.
 
This property is similar to the <b>Enable automatic error handling in new VIs</b> option on the Block Diagram page of the Options dialog box and the <b>Enable automatic error handling</b> option on the Execution page of the VI Properties dialog box.
 
 
<b>Note</b>  The LabVIEW Run-Time Engine does not support automatic error handling.
|R/W
|
|- style="background-color:#D1BB80;"
|27C
| [[VI class/BDMasterWizard property|BDMasterWizard]]
|
|R
|
|- style="background-color:#CCFFFF;"
|23C
| [[VI class/Diagram property|Diagram]]
|Returns a reference to the block diagram of the VI. This property is not available in stand-alone applications.
|R
|
|- style="background-color:#CCFFFF;"
|2C4
| [[VI class/BD Align Grid Size property|BD Align Grid Size]]
|
|R/W
|
|- style="background-color:#D1BB80;"
|2A0
| [[VI class/BDWin.NativeWindow property|BDWin.NativeWindow]]
|
|R
|
|- style="background-color:#CCFFFF;"
|237
| [[VI class/BDWin.Open property|BDWin.Open]]
|Opens or closes the block diagram window.
|R/W
|
|- style="background-color:#CCFFFF;"
|243
| [[VI class/BDWin.Origin property|BDWin.Origin]]
|Gets or sets the vertical and horizontal coordinates in the upper left-hand corner of the block diagram.
|R/W
|
|- style="background-color:#CCFFFF;"
|297
| [[VI class/BD.State property|BD.State]]
|Current state of the block diagram window.
|R
|X
|- style="background-color:#CCFFFF;"
|238
| [[VI class/BDWin.Bounds property|BDWin.Bounds]]
|Gets or sets the bounds for a block diagram window.
|R/W
|
|- style="background-color:#D1BB80;"
|2A2
| [[VI class/BDWin.WindInterface property|BDWin.WindInterface]]
|
|R
|
|- style="background-color:#FFFFCC;"
|220
| [[VI class/Callers property|Callers]]
|Returns a list of all the loaded VIs that call the referenced VI.
 
This property is similar to the <b>This VI's Callers</b> item in the View Menu.
|R
|X
|- style="background-color:#D1BB80;"
|281
| [[VI class/CallersPaths property|CallersPaths]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|2B3
| [[VI class/Compiled.CodeComplexity property|Compiled.CodeComplexity]]
|Returns the complexity of the referenced VI in relation to the <b>Compiler optimizations</b> 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.
 
This property provides programmatic access to the <b>Compiled Code Complexity</b> field on the Memory Usage page of the VI Properties dialog box.
 
 
<b>Note</b>  The value of this property is subject to change in future versions of LabVIEW.
 
Possible Errors
This property returns error 1000 if the referenced VI has never been compiled.
|R
|X
|- style="background-color:#CCFFFF;"
|2B4
| [[VI class/Compiled.LastCompiledWith property|Compiled.LastCompiledWith]]
|Returns 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.
 
This property provides programmatic access to the <b>Last compiled with</b> field on the Memory Usage page of the VI Properties dialog box. You can use this value to determine whether adjusting the complexity threshold can improve the execution speed of the referenced VI.
 
 
Possible Errors
This property returns error 1000 if the referenced VI has never been compiled.
|R
|X
|- style="background-color:#D1BB80;"
|2A7
| [[VI class/Compiler.GencodeProfilingResult property|Compiler.GencodeProfilingResult]]
|
|R
|
|- style="background-color:#D1BB80;"
|2A6
| [[VI class/Compiler.GencodeProfilingSettings property|Compiler.GencodeProfilingSettings]]
|
|R/W
|
|- style="background-color:#D1BB80;"
|2C6
| [[VI class/ConPane.CRC Ignore DD v2 property|ConPane.CRC Ignore DD v2]]
|
|R
|X
|- style="background-color:#D1BB80;"
|2C5
| [[VI class/ConPane.CRC v3 property|ConPane.CRC v3]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|27D
| [[VI class/ConPane.DataType property|ConPane.DataType]]
|Returns 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.
|R
|X
|- style="background-color:#CCFFFF;"
|23E
| [[VI class/ConPane.Ref property|ConPane.Ref]]
|Returns a reference to the connector pane of the VI.
|R
|X
|- style="background-color:#CCFFFF;"
|22A
| [[VI class/ConPane.SetConPane property|ConPane.SetConPane]]
|Sets the connector pane of the VI  to match the connector pane of the VI reference input.
 
Use this property to dynamically configure a VI connector pane to match the connector pane layout of an existing VI. The two VIs must have the same number of parameters with identical data types and names. If they do not, the Property Node returns an error. Use the Open VI Reference function to open references to both VIs and then wire those references to the Property Node and the Connector Pane:Set property input.
|W
|
|- style="background-color:#FFFFCC;"
|2A8
| [[VI class/ContainsCompiledCode property|ContainsCompiledCode]]
|Sets or returns whether the VI includes compiled code.
 
If TRUE, the VI includes compiled code. If FALSE, LabVIEW separates the compiled code and saves it in the VI object cache.
 
This property is similar to the <b>Separate compiled code from source file</b> option on the General page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|277
| [[VI class/HasEditsInAnotherContext property|HasEditsInAnotherContext]]
|
|R
|X
|- style="background-color:#D1BB80;"
|278
| [[VI class/HasEditsInThisContext property|HasEditsInThisContext]]
|
|R
|X
|- style="background-color:#D1BB80;"
|279
| [[VI class/IsReservedInOtherContext property|IsReservedInOtherContext]]
|
|R
|X
|- style="background-color:#D1BB80;"
|27A
| [[VI class/IsReservedInThisContext property|IsReservedInThisContext]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|256
| [[VI class/CtrlVIType property|CtrlVIType]]
|Specifies whether a control VI is a control, a typedef, or a strict typedef.  This property is valid for control VIs only.
|R/W
|X
|- style="background-color:#D1BB80;"
|2C1
| [[VI class/DidRecompileInThisVersion property|DidRecompileInThisVersion]]
|
|R
|X
|- style="background-color:#D1BB80;"
|29C
| [[VI class/DoNotShowSaveChangesDialog property|DoNotShowSaveChangesDialog]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|22E
| [[VI class/Edit Mode property|Edit Mode]]
|If 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.
 
To write this property, you must call it before you open the front panel of the VI.
|R/W
|X
|- style="background-color:#CCFFFF;"
|2BF
| [[VI class/Highlight? property|Highlight?]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|206
| [[VI class/Exec.AllowDebug property|Exec.AllowDebug]]
|If 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.
 
This property is similar to the <b>Allow debugging</b> option on the Execution page of the VI Properties dialog box.
 
<b>Note</b>  Writing this property causes the VI to be recompiled. Writing TRUE causes extra code and data to be generated for the VI. This code and data enables LabVIEW to set breakpoints and single-step through the VI. Writing FALSE removes this code and data, reducing the total size of the VI.
When you debug applications and shared libraries, you cannot debug reentrant panels that an Open VI Reference function creates. You also cannot debug reentrant panels that are entry points to LabVIEW-built shared libraries.
|R/W
|X
|- style="background-color:#FFFFCC;"
|20B
| [[VI class/Exec.CloseFPAfterCall property|Exec.CloseFPAfterCall]]
|Indicates whether to close the front panel after the VI runs.
 
<b>Note</b>  Use this property in conjunction with the Show Front Panel On Call property.
|R/W
|X
|- style="background-color:#D1BB80;"
|2AF
| [[VI class/Exec.CompiledWithSSE property|Exec.CompiledWithSSE]]
|
|R
|X
|- style="background-color:#D1BB80;"
|2B9
| [[VI class/Exec.DidCompilerOrUserApproveInlining property|Exec.DidCompilerOrUserApproveInlining]]
|
|R
|
|- style="background-color:#D1BB80;"
|2B8
| [[VI class/Exec.InlineSubVIEnum property|Exec.InlineSubVIEnum]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|2AB
| [[VI class/Exec.InlineIsAllowed property|Exec.InlineIsAllowed]]
|Returns TRUE if you can inline this subVI into its calling VIs.
|R
|
|- style="background-color:#FFFFCC;"
|2AA
| [[VI class/Exec.InlineSubVI property|Exec.InlineSubVI]]
|Specifies whether to inline the subVI into its calling VIs.
|R/W
|
|- style="background-color:#D1BB80;"
|2AE
| [[VI class/Exec.InlineSubVIIfPossible property|Exec.InlineSubVIIfPossible]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|20D
| [[VI class/Exec.IsReentrant property|Exec.IsReentrant]]
|Indicates whether a VI can be reentrant.
|R/W
|X
|- style="background-color:#FFFFCC;"
|22F
| [[VI class/Exec.PrefSys property|Exec.PrefSys]]
|Indicates the execution system in which the VI runs.
|R/W
|X
|- style="background-color:#FFFFCC;"
|20E
| [[VI class/Exec.Priority property|Exec.Priority]]
|Indicates the priority of the VI when it runs in parallel with other tasks.
 
This property is similar to the <b>Priority</b> option on the Execution page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|288
| [[VI class/Exec.ReentrancyType property|Exec.ReentrancyType]]
|Indicates the type of reentrancy LabVIEW uses for a reentrant VI.
 
This property is similar to options on the Execution Properties page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|26D
| [[VI class/Exec.RetainWireValues property|Exec.RetainWireValues]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|20C
| [[VI class/Exec.RunOnOpen property|Exec.RunOnOpen]]
|Indicates whether to run the VI when it opens.
 
This property is similar to the <b>Run when opened</b> option on the Execution page of the VI Properties dialog box.
 
<b>Note</b>  LabVIEW ignores this property when you load the VI using the VI Server. Use the Run VI method to run a VI you load using the VI Server.
|R/W
|X
|- style="background-color:#D1BB80;"
|2AC
| [[VI class/Exec.SSERuntimeOptimization property|Exec.SSERuntimeOptimization]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|20A
| [[VI class/Exec.ShowFPOnCall property|Exec.ShowFPOnCall]]
|Indicates whether to show the front panel when the VI is called.
 
This property is similar to the <b>Show front panel when called</b> option on the Customize Window Appearance dialog box and the <b>Show front panel when called</b> option on the SubVI Node Setup dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|209
| [[VI class/Exec.ShowFPOnLoad property|Exec.ShowFPOnLoad]]
|Indicates whether to show the front panel when the VI is loaded.
 
This property is similar to the <b>Show front panel when loaded</b> option on the Customize Window Appearance dialog box and the <b>Open front panel when loaded</b> option on the SubVI Node Setup dialog box.
 
<b>Note</b>  LabVIEW ignores this property when you load the VI using the VI Server. Use the Front Panel:Open method to open the front panel of a VI you load using the VI Server.
|R/W
|X
|- style="background-color:#D1BB80;"
|2BE
| [[VI class/Exec.ShrinkLargeBuffersThreshold property|Exec.ShrinkLargeBuffersThreshold]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|2BC
| [[VI class/Exec.ShrinkLargeBuffers property|Exec.ShrinkLargeBuffers]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|22D
| [[VI class/Exec.State property|Exec.State]]
|Indicates the execution state of the VI.
|R
|X
|- style="background-color:#FFFFCC;"
|22B
| [[VI class/Exec.SuspOnCall property|Exec.SuspOnCall]]
|Indicates whether LabVIEW suspends the execution of the VI when calling it as a subVI. Use this property carefully with reentrant VIs.
 
This property is similar to the <b>Suspend when called</b> option on the Execution page of the VI Properties dialog box, the <b>Suspend when called</b> option on the SubVI Node Setup dialog box, and the <b>Suspend when Called</b> item on the Operate menu.
|R/W
|X
|- style="background-color:#FFFFCC;"
|249
| [[VI class/Expand SubVI property|Expand SubVI]]
|Expands to show terminals when dropped as a subVI.
|R/W
|
|- style="background-color:#FFFFCC;"
|23D
| [[VI class/Panel property|Panel]]
|Reference to the front panel of a VI.
|R
|X
|- style="background-color:#D1BB80;"
|23B
| [[VI class/FPRefNumTD property|FPRefNumTD]]
|
|R
|
|- style="background-color:#CCFFFF;"
|2C3
| [[VI class/FP Align Grid Size property|FP Align Grid Size]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|1FC
| [[VI class/FP.AllowRTPopup property|FP.AllowRTPopup]]
|Indicates 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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|259
| [[VI class/FP.Behavior property|FP.Behavior]]
|Sets the behavior of the front panel window. Valid values include 0 (Invalid), 1 (Default), 2 (Floating), 3 (Floating/Auto-Hide), and 4 (Modal).
 
If you load the VI in a subpanel control, this property is read only.
 
This property is similar to the <b>Window Behavior</b>section in the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|1FA
| [[VI class/FP.Closeable property|FP.Closeable]]
|Indicates whether the close button in the title bar is disabled and the <b>Close</b> item in the <b>File</b> menu is disabled.
 
This property prevents users from closing a VI during execution.
 
If you load the VI in a subpanel control, this property is read only and always returns a value of FALSE.
|R/W
|X
|- style="background-color:#FFFFCC;"
|231
| [[VI class/FP.CustomTitle property|FP.CustomTitle]]
|Indicates whether the VI has a custom title string. Write FALSE to remove the custom title string.
|R/W
|X
|- style="background-color:#FFFFCC;"
|1FD
| [[VI class/FP.HiliteReturnBut property|FP.HiliteReturnBut]]
|Indicates whether to highlight Boolean controls that have a shortcut key of .
|R/W
|X
|- style="background-color:#D1BB80;"
|245
| [[VI class/FP.IsFloating property|FP.IsFloating]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|217
| [[VI class/FP.IsFrontmost property|FP.IsFrontmost]]
|Writing 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).
|R/W
|X
|- style="background-color:#FFFFCC;"
|23F
| [[VI class/FP.KeepWinProps property|FP.KeepWinProps]]
|Indicates 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.
 
This property is similar to the <b>Maintain proportions of window for different monitor resolutions</b> option on the Window Size page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|247
| [[VI class/FP.Minimizable property|FP.Minimizable]]
|Indicates whether the user can minimize the front panel window while the VI runs.
 
If you load the VI in a subpanel control, this property is read only and always returns a value of FALSE.
 
This property is similar to the <b>Allow user to minimize window</b> checkbox in the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|265
| [[VI class/FP.Minimum Size property|FP.Minimum Size]]
|Minimum 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.
 
You cannot size the window smaller than one pixel in either dimension. If you set a pane to a size at which the scroll bars encroach on the content area's minimum size, LabVIEW hides the scroll bars. When you size the pane larger, the scroll bars appear again. For single-pane front panels, minimum size refers to the content area of that pane, not including the scroll bars. For multi-pane front panels, minimum size refers to the entire front panel, including any visible scroll bars.
 
This property is similar to the <b>Minimum Panel Size</b> section of the Window Size page of the VI Properties dialog box.
 
Elements:
*Name
*Description
*Horizontal - The minimum width of the front panel window in pixels. This value cannot be less than 1.
*Vertical - The minimum height of the front panel window in pixels. This value cannot be less than 1.
|R/W
|X
|- style="background-color:#FFFFCC;"
|275
| [[VI class/FP.Monitor property|FP.Monitor]]
|The 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.
 
This property is similar to the <b>Monitor</b> option on the Window Run-Time Position page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|29F
| [[VI class/FP.NativeWindow property|FP.NativeWindow]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|22C
| [[VI class/FP.PanelBounds property|FP.PanelBounds]]
|The 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.
 
When you read this property, LabVIEW returns the front panel bounds of the VI. If the front panel of the VI is not open, LabVIEW returns the front panel bounds of the VI in the position it was last saved. The front panel  bounds adjust if you change the size or placement of objects in the front panel.  Dynamic changes in data can occur if you alter bound front panel objects.
 
If you load the VI in a subpanel control, this property is read only.
 
Elements:
*Name
*Description
*Left - The horizontal coordinate of the left edge of the interior portion of the front panel in global screen coordinates.
*Top - The vertical coordinate of the top edge of the interior portion of the front panel in global screen coordinates.
*Right - The horizontal coordinate of the right edge of the interior portion of the front panel in global screen coordinates.
*Bottom - The vertical coordinate of the bottom edge of the interior portion of the front panel in global screen coordinates.
|R/W
|X
|- style="background-color:#FFFFCC;"
|248
| [[VI class/FP.Resizable property|FP.Resizable]]
|Indicates whether the user can resize the front panel window while the VI runs.
 
If you load the VI in a subpanel control, this property is read only and always returns a value of FALSE.
 
This property is similar to the <b>Allow user to resize window</b> checkbox in the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|274
| [[VI class/FP:RunTransparently property|FP:RunTransparently]]
|Sets the VI to use a semi-transparent window style when running. Set the level of transparency using the Front Panel Window:Transparency property.
 
This property is similar to the <b>Window Runs Transparently</b> option in the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|201
| [[VI class/FP.ShowMenuBar property|FP.ShowMenuBar]]
|Indicates whether to display the menu bar on the front panel while the VI runs.
 
If you load the VI in a subpanel control, this property is read only and always returns a value of FALSE.
 
 
This property is similar to the <b>Show menu bar</b> option on the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|260
| [[VI class/FP.State property|FP.State]]
|Current state of the front panel window.
 
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.
 
Example
|R/W
|X
|- style="background-color:#FFFFCC;"
|229
| [[VI class/FP.Title property|FP.Title]]
|String that appears in the title bar. This string does not have to match the VI filename.
 
This property is similar to the <b>Window title</b> option on the Window Appearance page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|1F9
| [[VI class/FP.TitleBarVis property|FP.TitleBarVis]]
|Indicates whether to display a title bar on the front panel while the VI runs.
 
If you load the VI in a subpanel control, this property is read only and always returns a value of FALSE.
 
This property is similar to the <b>Window has title bar</b> option on the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|273
| [[VI class/FP:Transparency property|FP:Transparency]]
|Sets 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.
 
This property is similar to the <b>Window Runs Transparently</b> option in the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|218
| [[VI class/FP.WinBounds property|FP.WinBounds]]
|The 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.
 
When you read this property, LabVIEW returns the window bounds of the VI. If the front panel of the VI is not open, LabVIEW returns the window bounds of the VI in the position it was last saved.
 
If you load the VI in a subpanel control, this property is read only.
 
Elements
*Name
*Description
*Left - The horizontal coordinate of the left edge of the front panel window in global screen coordinates.
*Top - The vertical coordinate of the top edge of the front panel window in global screen coordinates.
*Right - The horizontal coordinate of the right edge of the front panel window in global screen coordinates.
*Bottom - The vertical coordinate of the bottom edge of the front panel window in global screen coordinates.
|R/W
|X
|- style="background-color:#D1BB80;"
|2A1
| [[VI class/FP.WindInterface property|FP.WindInterface]]
|
|R
|X
|- style="background-color:#D1BB80;"
|2AD
| [[VI class/HasMSN property|HasMSN]]
|
|R
|
|- style="background-color:#FFFFCC;"
|215
| [[VI class/Help.Path property|Help.Path]]
|Path or symbolic path to an HTML file (.htm or .html) or compiled help file (.chm or .hlp) to which the VI is linked.
 
If the path is to a compiled help file, use the Document Tag property to determine the specific topic in that help file.
 
This property is similar to the <b>Help Path</b> text box on the Documentation page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|214
| [[VI class/Help.Tag property|Help.Tag]]
|Index keyword or HTML filename for a topic in the compiled help file to which the VI is linked.
 
Use this property only when Document Path is a path to a compiled help file (.chm or .hlp).
 
For .chm files, this property can be an HTML filename or index keyword. To link to a bookmark within an HTML file, add # followed by the name of the bookmark to the end of the filename. For .hlp files, this property can be an index keyword.
 
This property is similar to the <b>Help Tag</b> text box on the Documentation page of the VI Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2BA
| [[VI class/Help.WebURL property|Help.WebURL]]
|URL for the web-based help topic to link to a VI from the <b>Detailed help</b> link in the Context Help window.
 
Use the Help:Use Web URL property to indicate that you want to link a VI to a web-based help file from the <b>Context Help</b> window.
|R/W
|X
|- style="background-color:#D1BB80;"
|27B
| [[VI class/Help.Examples property|Help.Examples]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|2BB
| [[VI class/Help.UseWebURL property|Help.UseWebURL]]
|Indicates whether to link to a web-based help file from the <b>Detailed help</b> link in the Context Help window for a VI.
 
Use the Help:Document Web URL property to specify the URL of the web-based help file.
|R/W
|X
|- style="background-color:#D1BB80;"
|258
| [[VI class/Hide Inst VI Caption property|Hide Inst VI Caption]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|210
| [[VI class/Hist.AddAtSave property|Hist.AddAtSave]]
|Indicates whether to add a comment to the VI revision history every time the VI is saved.
 
This property is similar to the options available in the History window.
|R/W
|
|- style="background-color:#FFFFCC;"
|1F7
| [[VI class/Hist.Text property|Hist.Text]]
|Returns all the text that was added to the VI revision history.
|R
|
|- style="background-color:#FFFFCC;"
|211
| [[VI class/Hist.PromptAtClose property|Hist.PromptAtClose]]
|Indicates whether to prompt for a VI revision history comment when the VI closes.
 
This property is similar to the options available in the History window.
|R/W
|
|- style="background-color:#FFFFCC;"
|212
| [[VI class/Hist.PrompAtSave property|Hist.PrompAtSave]]
|Indicates whether to prompt for a VI revision history comment when the VI is saved.
 
This property is similar to the options available in the History window.
|R/W
|
|- style="background-color:#FFFFCC;"
|213
| [[VI class/Hist.RecAppComments property|Hist.RecAppComments]]
|Indicates 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.
 
This property is similar to the <b>Record comments generated by LabVIEW</b> option on the Revision History page of the VI Properties dialog box.
|R/W
|
|- style="background-color:#FFFFCC;"
|234
| [[VI class/Hist.Revision property|Hist.Revision]]
|Current revision number of the VI.
 
When writing this property, you can write only a value greater than the current revision number. If you attempt to write a revision number whose value is less than the current revision number, the property returns an error. Use the Clear History method to reset the revision history and the revision number.
 
This property is similar to the <b>Next Revision</b> option in the History window.
|R/W
|
|- style="background-color:#FFFFCC;"
|20F
| [[VI class/Hist.UseDflt property|Hist.UseDflt]]
|Indicates whether to use the global default history or to use the values entered in other history properties.
 
This property is similar to the <b>Use the default history settings from the Options dialog box</b> option in the Revision History page of the VI Properties dialog box. You can specify the global default history in the <b>VI Properties</b> dialog box.
|R/W
|
|- style="background-color:#D1BB80;"
|2B5
| [[VI class/Inline Callees property|Inline Callees]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|286
| [[VI class/IsCloneVI property|IsCloneVI]]
|Returns TRUE if the VI is a clone of a reentrant VI.
|R
|X
|- style="background-color:#D1BB80;"
|2A3
| [[VI class/IsGeneric property|IsGeneric]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|2A9
| [[VI class/IsInPackedLibrary property|IsInPackedLibrary]]
|Returns TRUE if a packed project library contains the VI.
|R
|X
|- style="background-color:#FFFFCC;"
|241
| [[VI class/IsInstance property|IsInstance]]
|Returns whether or not the VI is an Express VI instance.
|R/W
|
|- style="background-color:#FFFFCC;"
|26A
| [[VI class/IsProbe property|IsProbe]]
|Returns TRUE if the VI is running as a probe and the probe VI is open.
|R
|
|- style="background-color:#FFFFCC;"
|2BD
| [[VI class/IsRunningInteractively property|IsRunningInteractively]]
|
|R
|X
|- style="background-color:#D1BB80;"
|296
| [[VI class/IsSkinned property|IsSkinned]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|264
| [[VI class/IsSystemVI property|IsSystemVI]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|2A4
| [[VI class/Is VI Paused? property|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.
|R
|
|- style="background-color:#D1BB80;"
|26E
| [[VI class/IsXNodeVI property|IsXNodeVI]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|290
| [[VI class/ItemID property|ItemID]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|299
| [[VI class/LadderVINeedsScripting property|LadderVINeedsScripting]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|276
| [[VI class/Library property|Library]]
|Returns 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.
|R
|
|- style="background-color:#D1BB80;"
|295
| [[VI class/LibraryPrivate property|LibraryPrivate]]
|
|R
|
|- style="background-color:#FFFFCC;"
|2B6
| [[VI class/Library.Version property|Library.Version]]
|Returns the version of the library that contains the VI you specify.
|R
|X
|- style="background-color:#D1BB80;"
|236
| [[VI class/Metric.Adv property|Metric.Adv]]
|
|R
|
|- style="background-color:#FFFFCC;"
|292
| [[VI class/Metric:BDLoaded property|Metric:BDLoaded]]
|Specifies whether the block diagram of the VI is in memory. The block diagram can be in memory even if the window is not open.
|R
|X
|- style="background-color:#FFFFCC;"
|21C
| [[VI class/Metric.CodeSize property|Metric.CodeSize]]
|Amount of memory used for VI code in bytes.
 
This property is similar to the <b>Code</b> option on the Memory Usage page of the VI Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|291
| [[VI class/Metric:FPLoaded property|Metric:FPLoaded]]
|Specifies whether the front panel of the VI is in memory. The front panel can be in memory even if the window is not open.
|R
|X
|- style="background-color:#D1BB80;"
|2B7
| [[VI class/Metric.NumberOfClones property|Metric.NumberOfClones]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|21F
| [[VI class/Metric.BDSize property|Metric.BDSize]]
|Size of the block diagram in bytes.
 
This property is similar to the <b>Block Diagram Objects</b> option on the Memory Usage page of the VI Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|21E
| [[VI class/Metric.FPSize property|Metric.FPSize]]
|Size of the front panel in bytes.
 
This property is similar to the <b>Front Panel Objects</b> option on the Memory Usage page of the VI Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|21D
| [[VI class/Metric.DataSize property|Metric.DataSize]]
|Amount of memory allocated for data in bytes.
 
You cannot read this property if the VI is running.
 
This property is similar to the <b>Data</b> option on the Memory Usage page of the VI Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|21B
| [[VI class/Mods.BlockDiagram property|Mods.BlockDiagram]]
|Indicates 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.
 
This property is similar to the options available on the Explain Changes dialog box.
|R
|
|- style="background-color:#FFFFCC;"
|21A
| [[VI class/Mods.FrontPanel property|Mods.FrontPanel]]
|Indicates 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.
 
This property is similar to the options available on the Explain Changes dialog box.
|R
|X
|- style="background-color:#D1BB80;"
|230
| [[VI class/Mods.UserChanges property|Mods.UserChanges]]
|
|R
|
|- style="background-color:#FFFFCC;"
|298
| [[VI class/Mods.VI property|Mods.VI]]
|Indicates 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.
 
This property is similar to the options available on the Explain Changes dialog box.
|R
|X
|- style="background-color:#D1BB80;"
|240
| [[VI class/Mods.VISignature property|Mods.VISignature]]
|
|R
|X
|- style="background-color:#D1BB80;"
|269
| [[VI class/Mods.VIUserCodeGUID property|Mods.VIUserCodeGUID]]
|
|R
|X
|- style="background-color:#D1BB80;"
|284
| [[VI class/NoCloneIfInstanceVI property|NoCloneIfInstanceVI]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|2A5
| [[VI class/NonProxyCallers property|NonProxyCallers]]
|
|R
|X
|- style="background-color:#D1BB80;"
|27E
| [[VI class/OverloadInfo property|OverloadInfo]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|26F
| [[VI class/OwningApp property|OwningApp]]
|Returns a reference to the application that owns the VI. Be sure and close this reference afterward.
|R
|X
|- style="background-color:#FFFFCC;"
|262
| [[VI class/Printing.BDScaling? property|Printing.BDScaling?]]
|If TRUE, LabVIEW scales the block diagram to fit on the printed page.
 
This property is similar to the <b>Scale printed block diagram to fit page</b> checkbox on the Print Options page of the VI Properties dialog box and the <b>Scale block diagram to fit</b> option on the <b>Printer</b> page of the Print dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24C
| [[VI class/Printing.FPScaling? property|Printing.FPScaling?]]
|If TRUE, LabVIEW scales the front panel to fit on the printed page.
 
This property is similar to the <b>Scale printed front panel to fit page</b> checkbox on the Print Options page of the VI Properties dialog box and the <b>Scale front panel to fit</b> option on the <b>Printer</b> page of the Print dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|250
| [[VI class/Printing.HeaderContent.DatePrinted? property|Printing.HeaderContent.DatePrinted?]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|251
| [[VI class/Printing.HeaderContent.ModifyDate? property|Printing.HeaderContent.ModifyDate?]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|252
| [[VI class/Printing.HeaderContent.PageNumber? property|Printing.HeaderContent.PageNumber?]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|253
| [[VI class/Printing.HeaderContent.VIIcon? property|Printing.HeaderContent.VIIcon?]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24E
| [[VI class/Printing.HeaderContent.VIName? property|Printing.HeaderContent.VIName?]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|254
| [[VI class/Printing.HeaderContent.VIPath? property|Printing.HeaderContent.VIPath?]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24D
| [[VI class/Printing.Margins property|Printing.Margins]]
|Gets or sets the page margins to use when printing the VI in inches or centimeters.
 
This property is similar to the <b>Use custom page margins</b> checkbox on the Print Options page of the VI Properties dialog box and the <b>Custom margins</b> option on the <b>Page Setup</b> page of the Print dialog box.
 
Elements
*Name
*Description
*Top - The margin to use for the top of the page in inches or centimeters.
*Left - The margin to use for the left side of the page in inches or centimeters.
*Bottom - The margin to use for the bottom of the page in inches or centimeters.
*Right - The margin to use for the right side of the page in inches or centimeters.
*Measurement System - The units of measure to use for the Top, Left, Bottom, and Right values.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24B
| [[VI class/Printing.Headers? property|Printing.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.
 
This property is similar to the <b>Print header (name, date, page number)</b> checkbox on the Print Options page of the VI Properties dialog box and the <b>Print header (name, date, page number)</b> checkbox on the <b>Page Setup</b> page of the Print dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|24A
| [[VI class/Printing.Orientation property|Printing.Orientation]]
|Gets or sets the page orientation to use when printing the VI.
|R/W
|X
|- style="background-color:#D1BB80;"
|255
| [[VI class/Purgative property|Purgative]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|244
| [[VI class/RT Menu Path property|RT Menu Path]]
|When 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.
 
Use this property to programmatically specify the path for a run-time menu (.rtm) file. This is useful if you are developing multilingual applications and you want to switch menus for each language programmatically.
|R/W
|X
|- style="background-color:#D1BB80;"
|2C2
| [[VI class/SavedVersion property|SavedVersion]]
|
|R
|X
|- style="background-color:#D1BB80;"
|28A
| [[VI class/SC.IsSubPanelEditable property|SC.IsSubPanelEditable]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|289
| [[VI class/SC.SuppressParse property|SC.SuppressParse]]
|
|R/W
|
|- style="background-color:#D1BB80;"
|26B
| [[VI class/SuppressDataMgr property|SuppressDataMgr]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|263
| [[VI class/SuppInstVIHalo property|SuppInstVIHalo]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|26C
| [[VI class/SuppressTransactInfo property|SuppressTransactInfo]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|287
| [[VI class/SuppressTypeProp property|SuppressTypeProp]]
|
|R/W
|
|- style="background-color:#D1BB80;"
|2B1
| [[VI class/TaggedAndNotEdited property|TaggedAndNotEdited]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|2B0
| [[VI class/TermBnds() property|TermBnds()]]
|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.
 
This property provides a more efficient way to obtain the terminal bounds of a connector pane than the similar Connector Pane:Terminal Bounds[] property. The Connector Pane:Terminal Bounds[] property causes slower run-time performance because it requires LabVIEW to load and maintain the front panel of the associated VI in memory, even if you close the connector pane reference with the Close Reference function. The VI:Terminal Bounds[] property does not load the front panel of the associated VI into memory.
 
 
Use this property to avoid the negative run-time performance impact of the Connector Pane:Terminal Bounds[] property, such as when you need to inspect the terminal bounds of a connector pane from a custom plug-in for the Icon Editor.
 
 
The array elements are in terminal order as defined in the Connector Pane Pattern Reference VI for each connector pane pattern.
|R
|X
|- style="background-color:#FFFFCC;"
|205
| [[VI class/TB.ShowAbortBut property|TB.ShowAbortBut]]
|Indicates whether to display the <b>Abort Execution</b> button on the toolbar while the VI runs.
 
This property is similar to the <b>Show Abort button</b> option on the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|204
| [[VI class/TB.ShowFreeRunBut property|TB.ShowFreeRunBut]]
|Indicates whether to display the <b>Run Continuously</b> button on the toolbar while the VI runs.
 
This property is similar to the <b>Show Run Continuously button</b> option on the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|203
| [[VI class/TB.ShowRunBut property|TB.ShowRunBut]]
|Indicates whether to display the <b>Run</b> button on the toolbar while the VI runs.
 
This property is similar to the <b>Show Run button </b> option on the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|202
| [[VI class/TB.Visible property|TB.Visible]]
|Indicates whether to display the toolbar while the VI runs.
 
This property is similar to the <b>Show toolbar when running</b> option on the Customize Window Appearance dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|23A
| [[VI class/ToolKitAttr property|ToolKitAttr]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|285
| [[VI class/CloneName property|CloneName]]
|Name of the clone of a reentrant VI. Returns an error if the VI is not a clone.
|R
|X
|- style="background-color:#D1BB80;"
|282
| [[VI class/CompileTime property|CompileTime]]
|
|R
|
|- style="background-color:#FFFFCC;"
|1F6
| [[VI class/Desc property|Desc]]
|Description 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.
 
This property is similar to the <b>VI Description</b> text box on the Documentation page of the VI Properties dialog box. You can format the text in the description to appear bold in the Context Help window.
|R/W
|X
|- style="background-color:#D1BB80;"
|257
| [[VI class/VILinkerErr property|VILinkerErr]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|1F4
| [[VI class/Name property|Name]]
|Name 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.
 
<b>Note</b>  To obtain only the VI filename, use the VI Path property, which returns the path to the VI. Then use the Strip Path function.
You can write this property only if the VI has not been saved to disk.
|R/W
|X
|- style="background-color:#FFFFCC;"
|1F5
| [[VI class/Path property|Path]]
|Path to the VI file.
 
This property is similar to the <b>Location</b> option on the General page of the VI Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|232
| [[VI class/VIType property|VIType]]
|Indicates the type of VI.
|R
|X
|}
</div>


==Methods==
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide VI Methods Table</span>
{{VIServerMethodsTable|2}}
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ VI Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|3EC
| [[VI class/Abort VI method|Abort VI]]
|Aborts the execution of a top-level VI.
 
This method returns error 1000 if you call it on a subVI. Otherwise, this method is similar to pressing the <b>Abort Execution</b> button on the toolbar.
|X
|- style="background-color:#CCFFFF;"
|43C
| [[VI class/Adapt Nodes method|Adapt Nodes]]
|Allows LabVIEW to replace overloaded nodes with more appropriate implementations.  For example, if you script an Add function and wire a Matrix control to it, LabVIEW breaks the wire. If you call Adapt Nodes, the Add function might be replaced with a Matrix Add VI. Operator overloading will not occur during scripting. You must call this method for Overloading to happen.
|
|- style="background-color:#D1BB80;"
|43B
| [[VI class/Adapt Nodes Private method|Adapt Nodes Private]]
|
|
|- style="background-color:#D1BB80;"
|44E
| [[VI class/AddASPending method|AddASPending]]
|
|
|- style="background-color:#D1BB80;"
|4A5
| [[VI class/Try Set Disconnect From Callers Needed method|Try Set Disconnect From Callers Needed]]
|
|
|- style="background-color:#D1BB80;"
|462
| [[VI class/SuppressBackup (Not Implemented) method|SuppressBackup (Not Implemented)]]
|
|X
|- style="background-color:#D1BB80;"
|463
| [[VI class/UnsuppressBackup (Not Implemented) method|UnsuppressBackup (Not Implemented)]]
|
|X
|- style="background-color:#D1BB80;"
|45E
| [[VI class/BeginScript (Not Implemented) method|BeginScript (Not Implemented)]]
|
|X
|- style="background-color:#FFFFCC;"
|474
| [[VI class/BD.CleanUp method|BD.CleanUp]]
|Cleans up the block diagram of the VI by rearranging and resizing its objects and signals to improve readability. You also can select <b>Edit&#0187;Clean Up Diagram</b> to clean up the block diagram.
 
This method is available only in edit mode.
|X
|- style="background-color:#FFFFCC;"
|42C
| [[VI class/BD.Get Image Scaled method|BD.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 <b>maximum width</b> and a value of 100 to <b>maximum height</b>, this method returns an image that is 50 by 50 pixels. If you do not wire a value to <b>maximum width</b> or <b>maximum height</b>, the image retains its actual size.
 
 
 
You also can use the Append VI Block Diagram to Report VI to create an image of a block diagram and append it to a report.
|
|- style="background-color:#D1BB80;"
|478
| [[VI class/BD.OpenInNativeWind method|BD.OpenInNativeWind]]
|
|X
|- style="background-color:#CCFFFF;"
|410
| [[VI class/BD.Remove Bad Wires method|BD.Remove Bad Wires]]
|Removes all the broken wires on the block diagram of the VI.
 
This method is similar to selecting <b>Edit&#0187;Remove Broken Wires</b>.
|
|- style="background-color:#D1BB80;"
|439
| [[VI class/BD.Set Mod method|BD.Set Mod]]
|
|
|- style="background-color:#D1BB80;"
|437
| [[VI class/Cause Type Propagation method|Cause Type Propagation]]
|
|X
|- style="background-color:#D1BB80;"
|49F
| [[VI class/Check AppBuilder Cache method|Check AppBuilder Cache]]
|
|
|- style="background-color:#FFFFCC;"
|419
| [[VI class/Clear History method|Clear History]]
|Clears the revision history of the referenced VI.
 
This method is similar to the <b>Reset</b> button on the History window.
|
|- style="background-color:#D1BB80;"
|4AE
| [[VI class/ClearTypeCastLinkRefs method|ClearTypeCastLinkRefs]]
|
|
|- style="background-color:#D1BB80;"
|46E
| [[VI class/CodeCov.Percentage method|CodeCov.Percentage]]
|
|
|- style="background-color:#D1BB80;"
|46D
| [[VI class/CodeCov.Reset method|CodeCov.Reset]]
|
|
|- style="background-color:#D1BB80;"
|46F
| [[VI class/CodeCov.UnrunDiags method|CodeCov.UnrunDiags]]
|
|
|- style="background-color:#D1BB80;"
|493
| [[VI class/CompileToDFIRCPP method|CompileToDFIRCPP]]
|
|
|- style="background-color:#D1BB80;"
|491
| [[VI class/CompileToDFIRXML (Not Implemented) method|CompileToDFIRXML (Not Implemented)]]
|
|X
|- style="background-color:#CCFFFF;"
|466
| [[VI class/Compile method|Compile]]
|Compiles the VI and optionally the entire VI hierarchy of that VI.
 
<b>Note</b>  This method does not show a modification, or asterisk (*) in the title bar, for the VI unless you included the 0x01 option flag as part of the <b>options</b> input to the Open VI Reference function when you opened the VI reference.
|X
|- style="background-color:#CCFFFF;"
|4B0
| [[VI class/Configure Panel As Hidden method|Configure Panel As Hidden]]
|
|
|- style="background-color:#D1BB80;"
|4AD
| [[VI class/ContainsLinkRef method|ContainsLinkRef]]
|
|
|- style="background-color:#D1BB80;"
|457
| [[VI class/CtlVIApplyChanges method|CtlVIApplyChanges]]
|
|X
|- style="background-color:#FFFFCC;"
|41C
| [[VI class/Ctrl Val.Get method|Ctrl Val.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.
 
<b>Note</b>  This method requires the VI to have a front panel. If you are using the Application Builder, make sure you do not remove the front panel.
For optimization purposes, LabVIEW does not keep track of data values on controls and indicators until LabVIEW determines you want them, that is, until you call this method or display the front panel. When you display the front panel, LabVIEW begins keeping track of the values.
 
The first time you call this method on a VI whose front panel is not open, this method returns the default values of the control or indicator rather than the actual values. Thereafter, it returns the actual value.
|X
|- style="background-color:#FFFFCC;"
|41D
| [[VI class/Ctrl Val.Get All method|Ctrl Val.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.
 
<b>Note</b>  This method requires the VI to have a front panel. If you are using the Application Builder, make sure you do not remove the front panel.
For optimization purposes, LabVIEW does not keep track of data values on controls and indicators until LabVIEW determines you want them, that is, until you call this method or display the front panel. When you display the front panel, LabVIEW begins keeping track of the values.
 
The first time you call this method on a VI whose front panel is not open, this method returns the default values of the control or indicator rather than the actual values. Thereafter, it returns the actual value.
|X
|- style="background-color:#D1BB80;"
|46B
| [[VI class/Ctrl Val.Get Array Element Default method|Ctrl Val.Get Array Element Default]]
|
|X
|- style="background-color:#D1BB80;"
|46A
| [[VI class/Ctrl Val.Get Default method|Ctrl Val.Get Default]]
|
|X
|- style="background-color:#D1BB80;"
|470
| [[VI class/Ctrl Val.Get Type method|Ctrl Val.Get Type]]
|
|X
|- style="background-color:#FFFFCC;"
|41B
| [[VI class/Ctrl Val.Set method|Ctrl Val.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.
 
<b>Note</b>  This method requires the VI to have a front panel. If you are using the Application Builder, make sure you do not remove the front panel.
|X
|- style="background-color:#D1BB80;"
|4A1
| [[VI class/Ctrl Val.Set Multiple method|Ctrl Val.Set Multiple]]
|
|X
|- style="background-color:#D1BB80;"
|485
| [[VI class/Copy VI Hierarchy FPGA method|Copy VI Hierarchy FPGA]]
|
|
|- style="background-color:#CCFFFF;"
|49D
| [[VI class/Create from Data Type method|Create from Data Type]]
|Creates a control or constant of the data type you specify. LabVIEW always creates a control initially, even if you configure <b>Style</b> to create a constant or indicator. To change the type of the new object, use the Indicator property.
 
Use the To More Specific Class function to try to cast the reference this method returns to the specific class you want to use in the application. If the function does not return an error, the reference matches the specific class.
|
|- style="background-color:#CCFFFF;"
|443
| [[VI class/Create from Reference method|Create from Reference]]
|Creates a constant or control using a constant or control reference as a template.
|
|- style="background-color:#CCFFFF;"
|484
| [[VI class/Debugging:GetButtonState method|Debugging:GetButtonState]]
|Returns TRUE if the button is enabled or FALSE if the button is grayed out. This method also returns the string for the tip strip associated with the button. For example, this method might return Step into For Loop for the <b>Step Into</b> button.
|X
|- style="background-color:#CCFFFF;"
|481
| [[VI class/Debugging:StepInto method|Debugging:StepInto]]
|Single-steps through a VI to help you debug the VI. To use this method, the VI must be paused.
 
This method is similar to the <b>Step Into</b> button on the block diagram toolbar.
|X
|- style="background-color:#CCFFFF;"
|483
| [[VI class/Debugging:StepOut method|Debugging:StepOut]]
|Single-steps through a VI to help you debug the VI. To use this method, the VI must be paused.
 
This method is similar to the <b>Step Out</b> button on the block diagram toolbar.
|X
|- style="background-color:#CCFFFF;"
|482
| [[VI class/Debugging:StepOver method|Debugging:StepOver]]
|Single-steps through a VI to help you debug the VI. To use this method, the VI must be paused.
 
This method is similar to the <b>Step Over</b> button on the block diagram toolbar.
|X
|- style="background-color:#FFFFCC;"
|3F3
| [[VI class/Default Vals.Make Curr Default method|Default Vals.Make Curr Default]]
|Changes the defaults of all controls on the front panel to be the current values. This method is available only in edit mode.
 
This method is similar to the Make Current Value Default item on the shortcut menu of a control and the <b>Make Current Values Default</b> item in the Edit menu.
|
|- style="background-color:#FFFFCC;"
|3F4
| [[VI class/Default Vals.Reinit All method|Default Vals.Reinit All]]
|Changes the current values of all controls on the front panel to their defaults.
 
This method is similar to the <b>Reinitialize Values to Default</b> item in the Edit menu.
|X
|- style="background-color:#D1BB80;"
|468
| [[VI class/DeployVI method|DeployVI]]
|
|X
|- style="background-color:#FFFFCC;"
|479
| [[VI class/Detect Parallel Loops method|Detect Parallel Loops]]
|Detects parallel loops in the VI.
|
|- style="background-color:#FFFFCC;"
|44B
| [[VI class/DisconnectFromLibrary method|DisconnectFromLibrary]]
|Disconnects a VI that a LabVIEW project library owns from the owning project library.
|
|- style="background-color:#D1BB80;"
|414
| [[VI class/Disconnect Polys And Typedefs method|Disconnect Polys And Typedefs]]
|
|
|- style="background-color:#CCFFFF;"
|401
| [[VI class/Empty method|Empty]]
|Empties the front panel and block diagram of the VI.
|
|- style="background-color:#D1BB80;"
|45F
| [[VI class/EndScript (Not Implemented) method|EndScript (Not Implemented)]]
|
|X
|- style="background-color:#D1BB80;"
|43F
| [[VI class/Enter Text method|Enter Text]]
|
|X
|- style="background-color:#D1BB80;"
|4A4
| [[VI class/Export Interface method|Export Interface]]
|
|X
|- style="background-color:#D1BB80;"
|411
| [[VI class/Fake Exec State method|Fake Exec State]]
|
|X
|- style="background-color:#FFFFCC;"
|464
| [[VI class/FindCtrlWithKeyFocus method|FindCtrlWithKeyFocus]]
|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.
|X
|- style="background-color:#FFFFCC;"
|441
| [[VI class/FP.Center method|FP.Center]]
|Specifies whether to automatically center the front panel window on the computer screen.
 
This method is similar to the <b>Centered</b> option of the <b>Position</b> pull-down menu on the Window Run-Time Position page of the <b>VI Properties</b> dialog box.
|X
|- style="background-color:#FFFFCC;"
|425
| [[VI class/FP.Close method|FP.Close]]
|Closes the front panel window.
 
Use the Front Panel:Open method to open a front panel window.
 
Example
|X
|- style="background-color:#FFFFCC;"
|423
| [[VI class/FP.Get Image method|FP.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.
 
If a front panel is not visible, LabVIEW does not update the values in the objects on the front panel. If you call a VI whose front panel is not visible and you use the Front Panel:Get Image method to create an image of the front panel, the image does not reflect any value changes that occurred when you ran the VI.
 
If you want the image to reflect value changes, make sure the front panel is open before any values change. If you do not want to display the front panel but want the image to reflect value changes, create a Property Node from any terminal on the block diagram of the VI for which you want to create a front panel image.
 
You also can use the Append Front Panel Image to Report VI to create an image of a front panel and append it to a report.
|X
|- style="background-color:#FFFFCC;"
|426
| [[VI class/FP.Get Image Scaled method|FP.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.
 
 
 
If a front panel is not visible, LabVIEW does not update the values in the objects on the front panel. If you call a VI whose front panel is not visible and you use the Front Panel:Get Image Scaled method to create an image of the front panel, the image does not reflect any value changes that occurred when you ran the VI.
 
If you want the image to reflect value changes, make sure the front panel is open before any values change. If you do not want to display the front panel but want the image to reflect value changes, wire a Property Node to any terminal on the block diagram of the VI for which you want to create a front panel image.
 
You also can use the Append Front Panel Image to Report VI to create an image of a front panel and append it to a report.
|X
|- style="background-color:#FFFFCC;"
|438
| [[VI class/FP.Open method|FP.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.
 
Use the Front Panel:Close method to close the front panel window.
 
You also can use the Front Panel Window:State property to set the state of a front panel window that is already open.
 
Example
|X
|- style="background-color:#D1BB80;"
|477
| [[VI class/FP.OpenInNativeWind method|FP.OpenInNativeWind]]
|
|X
|- style="background-color:#FFFFCC;"
|447
| [[VI class/FP.Run-Time Position.Centered method|FP.Run-Time Position.Centered]]
|Configures the referenced VI to center its front panel  every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.
 
If you want to change the position of the VI while it is running, use the Front Panel Window:Window Bounds property instead.
 
This method is similar to selecting <b>Centered</b> from the <b>Position</b> pull-down menu on the Window Run-Time Position page of the VI Properties dialog box.
|X
|- style="background-color:#FFFFCC;"
|44A
| [[VI class/FP.Run-Time Position.Custom method|FP.Run-Time Position.Custom]]
|Configures the referenced VI to open its front panel in a custom position every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.
 
If you want to change the position of the VI while it is running, use the Front Panel Window:Window Bounds property instead.
 
This method is similar to selecting <b>Custom</b> from the <b>Position</b> pull-down menu on the Window Run-Time Position page of the VI Properties dialog box.
|X
|- style="background-color:#FFFFCC;"
|445
| [[VI class/FP.Run-Time Pos.Get method|FP.Run-Time Pos.Get]]
|Returns the default position of the front panel window at run-time.
|X
|- style="background-color:#FFFFCC;"
|448
| [[VI class/FP.Run-Time Position.Maximized method|FP.Run-Time Position.Maximized]]
|Configures a VI to maximize its front panel every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.
 
If you want to change the position of the VI while it is running, use the Front Panel Window:Window Bounds property instead.
 
This method is similar to selecting <b>Maximized</b> from the <b>Position</b> pull-down menu on the Window Run-Time Position page of the VI Properties dialog box.
|X
|- style="background-color:#FFFFCC;"
|449
| [[VI class/FP.Run-Time Position.Minimized method|FP.Run-Time Position.Minimized]]
|Sets a VI to minimize its front panel every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.
 
This method is similar to selecting <b>Minimized</b> from the <b>Position</b> pull-down menu on the Window Run-Time Position page of the VI Properties dialog box.
|X
|- style="background-color:#FFFFCC;"
|446
| [[VI class/FP.Run-Time Pos.Unchanged method|FP.Run-Time Pos.Unchanged]]
|Configures the VI to maintain the position of its front panel window when the VI runs.
 
This method is similar to selecting <b>Unchanged</b> from the <b>Position</b> pull-down menu on the Window Run-Time Position page of the VI Properties dialog box.
|X
|- style="background-color:#D1BB80;"
|434
| [[VI class/FP.Set Close If Lonely method|FP.Set Close If Lonely]]
|
|X
|- style="background-color:#D1BB80;"
|43A
| [[VI class/FP.Set Mod method|FP.Set Mod]]
|
|
|- style="background-color:#D1BB80;"
|440
| [[VI class/Gen C Code Variant method|Gen C Code Variant]]
|
|X
|- style="background-color:#D1BB80;"
|412
| [[VI class/Generate VHDL method|Generate VHDL]]
|
|
|- style="background-color:#D1BB80;"
|4AA
| [[VI class/Get AppBuilder Source Checksum method|Get AppBuilder Source Checksum]]
|
|
|- style="background-color:#D1BB80;"
|49E
| [[VI class/GetCallPathsToOtherVI method|GetCallPathsToOtherVI]]
|
|X
|- style="background-color:#FFFFCC;"
|495
| [[VI class/GetCompileMetrics method|GetCompileMetrics]]
|Returns a string that describes transform metrics from the most recent compile of the VI, if metric recording was enabled.
|X
|- style="background-color:#CCFFFF;"
|42D
| [[VI class/Get Conpane Image method|Get Conpane Image]]
|Returns the connector pane image, as it appears in the Context Help window, 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.
 
The clusters returned by this method are similar to the <b>image data</b> output of the Read JPEG File, Read PNG File, and Read BMP File VIs.
|X
|- style="background-color:#FFFFCC;"
|4A7
| [[VI class/GetControlIndexByName method|GetControlIndexByName]]
|Gets the index for the control or indicator of the given name. If the control or indicator for which you want to get an index does not have a terminal on the block diagram, this method returns an error.
 
You can use this method to specify the controls for which you get or set values with the Get Control Values by Index or Set Control Values by Index functions.
|X
|- style="background-color:#D1BB80;"
|452
| [[VI class/Get Errors method|Get Errors]]
|
|X
|- style="background-color:#CCFFFF;"
|49B
| [[VI class/Get Library Access Scope method|Get Library Access Scope]]
|Returns the access scope or inherited access scope of this VI if it is owned by a LabVIEW project library. This method provides the same information as the method Source Scope:Get of the Project Library class without requiring a reference to the owning project library.
|
|- style="background-color:#D1BB80;"
|461
| [[VI class/GetMenuItemState (Not Implemented) method|GetMenuItemState (Not Implemented)]]
|
|X
|- style="background-color:#D1BB80;"
|4AC
| [[VI class/GetMissingDependenciesInfo method|GetMissingDependenciesInfo]]
|
|X
|- style="background-color:#D1BB80;"
|46C
| [[VI class/GetNamedInstanceVI method|GetNamedInstanceVI]]
|
|X
|- style="background-color:#FFFFCC;"
|4A9
| [[VI class/GetObjRefFromBkmrkID method|GetObjRefFromBkmrkID]]
|Returns a reference to the object, such as the label, that contains the bookmark.
|X
|- style="background-color:#D1BB80;"
|4AF
| [[VI class/GetUDClassLinkRefs method|GetUDClassLinkRefs]]
|
|
|- style="background-color:#FFFFCC;"
|4A8
| [[VI class/GetVIBookmarks method|GetVIBookmarks]]
|Returns the bookmark information for the specified VI reference. You must load the VI into memory in order to read the bookmark information. This method returns an error if the VI is password protected or if the VI does not have a block diagram.
|X
|- style="background-color:#FFFFCC;"
|47A
| [[VI class/Get VI Dependencies method|Get VI Dependencies]]
|This method returns the names and paths of the VI dependencies of a VI. You can use this method to return a specific subset of the total set of VI dependencies of a VI. This method does not return non-VI dependencies, such as project libraries, XControls, classes, and statecharts.
 
LabVIEW combines the parameter values you specify using the logical AND operator to determine which dependencies to return. For example, you must pass TRUE to both <b>Static VI Refs?</b> and <b>Include Control VIs?</b> in order for LabVIEW to return a static VI reference to a custom control or indicator.
 
By default, this method does not load the block diagram into memory. However, if you specify certain input values, LabVIEW loads the block diagram.
|X
|- style="background-color:#D1BB80;"
|4B1
| [[VI class/GetAllHierarchyRefers method|GetAllHierarchyRefers]]
|
|X
|- style="background-color:#D1BB80;"
|4A6
| [[VI class/GetXMLDataTypes method|GetXMLDataTypes]]
|
|X
|- style="background-color:#D1BB80;"
|454
| [[VI class/GiveTemporaryUnsavedName method|GiveTemporaryUnsavedName]]
|
|
|- style="background-color:#D1BB80;"
|4AB
| [[VI class/InternalStats method|InternalStats]]
|
|X
|- style="background-color:#D1BB80;"
|45D
| [[VI class/InvokeBuiltinMenuItem (Not Implemented) method|InvokeBuiltinMenuItem (Not Implemented)]]
|
|X
|- style="background-color:#D1BB80;"
|469
| [[VI class/LadderVIClearLadderEditor method|LadderVIClearLadderEditor]]
|
|X
|- style="background-color:#D1BB80;"
|47F
| [[VI class/Get Next VI method|Get Next VI]]
|
|X
|- style="background-color:#D1BB80;"
|47E
| [[VI class/Get Previous VI method|Get Previous VI]]
|
|X
|- style="background-color:#D1BB80;"
|49C
| [[VI class/HasLibrary? method|HasLibrary?]]
|
|X
|- style="background-color:#D1BB80;"
|494
| [[VI class/License.Get License Status method|License.Get License Status]]
|
|X
|- style="background-color:#FFFFCC;"
|3FD
| [[VI class/Lock State.Get method|Lock State.Get]]
|Returns the lock state of the VI and indicates whether the password for the VI is in the password cache.
|X
|- style="background-color:#FFFFCC;"
|3FE
| [[VI class/Lock State.Set method|Lock State.Set]]
|Sets the lock state of a VI. If <b>interactive</b> is FALSE (default), you can use <b>password</b> to either unlock a password-protected VI or set the password of an unprotected VI. If <b>interactive</b> is TRUE, LabVIEW ignores <b>password</b> and displays a dialog box that prompts you to change the lock state.
 
This method is similar to the <b>Unlocked (no password)</b>, <b>Locked (no password)</b>, and <b>Password-protected</b> options on the Protection page of the VI Properties dialog box.
|
|- style="background-color:#CCFFFF;"
|460
| [[VI class/MoveObjects method|MoveObjects]]
|Moves the objects by the offset amount of pixels.
|
|- style="background-color:#CCFFFF;"
|480
| [[VI class/PauseVI method|PauseVI]]
|Pauses or unpauses the VI execution.
|
|- style="background-color:#FFFFCC;"
|4A2
| [[VI class/Populate Async Call Pool method|Populate Async Call Pool]]
|Ensures that the asynchronous call pool for a VI reference contains at least the number of data spaces specified by the <b>Minimum Size</b> parameter. By default, when you open a reference with the Open VI Reference function, LabVIEW allocates one data space per CPU core on the development computer.
 
Use this method to ensure deterministic execution of asynchronous VI calls. Set the <b>Minimum Size</b> of the call pool to the maximum number of calls that you expect to make to the referenced VI. This prevents LabVIEW from needing to allocate data spaces in the asynchronous call pool on demand, thereby avoiding the jitter of memory allocation.
|X
|- style="background-color:#CCFFFF;"
|415
| [[VI class/Print.Panel To PostScript method|Print.Panel To PostScript]]
|Prints the panel of the VI to the specified PostScript file.
|X
|- style="background-color:#FFFFCC;"
|3FB
| [[VI class/Print.Panel To Printer method|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.
|X
|- style="background-color:#FFFFCC;"
|3EE
| [[VI class/Print.VI To HTML method|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.
 
This method is similar to the <b>HTML file</b> option on the <b>Destination</b> page of the Print dialog box.
|
|- style="background-color:#FFFFCC;"
|3ED
| [[VI class/Print.VI To Printer method|Print.VI To Printer]]
|Prints the VI information to a printer.
 
If you use this method in a stand-alone application or shared library, LabVIEW prints only the front panel. This method is similar to the <b>Printer</b> option on the <b>Destination</b> page of the Print dialog box.
|X
|- style="background-color:#FFFFCC;"
|3EF
| [[VI class/Print.VI To RTF method|Print.VI To RTF]]
|Saves the VI information to an RTF file.
 
This method is similar to the <b>Rich Text Format (RTF) file</b> option on the <b>Destination</b> page of the Print dialog box.
|
|- style="background-color:#FFFFCC;"
|3F0
| [[VI class/Print.VI To Text method|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.
 
This method is similar to the <b>Plain text file</b> option on the <b>Destination</b> page of the Print dialog box.
|
|- style="background-color:#D1BB80;"
|473
| [[VI class/RefreshErrWinEntry method|RefreshErrWinEntry]]
|
|X
|- style="background-color:#FFFFCC;"
|430
| [[VI class/RP.Client Connections method|RP.Client Connections]]
|Returns an array of clusters containing connection information about the clients viewing or controlling the VI.
 
LabVIEW opens a connection on the server computer when another application instance or a related application, such as a Web browser, requests to view the front panel of a VI in memory on the server computer.
 
This method can return networking error codes.
 
Example
|X
|- style="background-color:#FFFFCC;"
|431
| [[VI class/RP.Close Connection To Client method|RP.Close Connection To Client]]
|Closes a remote front panel connection to a client.
 
This method can return networking error codes.
 
Example
|X
|- style="background-color:#FFFFCC;"
|42E
| [[VI class/RP.Lock Control method|RP.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.
 
This method is similar to the <b>Regain Control</b> and Lock Control shortcut menu items on the front panel of a running VI.
 
Example
|X
|- style="background-color:#FFFFCC;"
|42F
| [[VI class/RP.Unlock Control method|RP.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.
 
This method is similar to the Unlock Control shortcut menu item on the front panel of a running VI.
 
Example
|X
|- style="background-color:#D1BB80;"
|44F
| [[VI class/RemoveBreakpoints method|RemoveBreakpoints]]
|
|X
|- style="background-color:#CCFFFF;"
|44D
| [[VI class/Replicate Conpane method|Replicate Conpane]]
|Make the connector pane of the VI Reference match the given connector pane.
|X
|- style="background-color:#D1BB80;"
|492
| [[VI class/ResetGencodeProfileResults method|ResetGencodeProfileResults]]
|
|
|- style="background-color:#FFFFCC;"
|3FA
| [[VI class/Revert VI method|Revert VI]]
|Discards changes and reloads a VI from disk.
 
This method is similar to the <b>Revert</b> item on the File menu.
|
|- style="background-color:#FFFFCC;"
|3EB
| [[VI class/Run VI method|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.
 
<b>Note</b>  This method requires the VI to have a front panel. If you are using the Application Builder, make sure you do not remove the front panel.
You cannot use this method to run a VI that is already reserved for execution by another VI.
 
If you use the Open VI Reference function and wire the <b>type specifier VI Refnum</b> input, you cannot use the reference returned by the function with this method. Instead, you must use the Call By Reference node.
 
If you want to use this method with a reentrant VI, set the <b>options</b> parameter to 0x08 in the Open VI Reference function to prepare the VI for reentrant run.
|X
|- style="background-color:#D1BB80;"
|467
| [[VI class/Run VI And Deploy method|Run VI And Deploy]]
|
|X
|- style="background-color:#D1BB80;"
|45A
| [[VI class/Save.CopyAsSystem method|Save.CopyAsSystem]]
|
|X
|- style="background-color:#FFFFCC;"
|400
| [[VI class/Save.For Previous method|Save.For Previous]]
|Saves a copy of the VI that is readable by LabVIEW version 8.0 and later. If you save a password-protected VI for a previous LabVIEW version, you must enter the password. You can enter the password programmatically as an input on the Open VI Reference function.
 
This method is similar to the <b>LabVIEW Version</b> option on the Save for Previous Version dialog box.
|
|- style="background-color:#FFFFCC;"
|3EA
| [[VI class/Save.Instrument method|Save.Instrument]]
|Saves a VI that is not currently running and synchronizes the VI with the edited version in other application instances before saving.
 
This method is similar to the <b>Save</b> item on the File menu.
 
<b>Note</b>  If you use this method to save a VI that is currently running, LabVIEW returns error 1507.
|
|- style="background-color:#D1BB80;"
|451
| [[VI class/Save.Instrument(NoSync) method|Save.Instrument(NoSync)]]
|
|
|- style="background-color:#D1BB80;"
|3FF
| [[VI class/Private Save Instrument method|Private Save Instrument]]
|
|
|- style="background-color:#D1BB80;"
|45C
| [[VI class/Save.Instrument and Callers Debug method|Save.Instrument and Callers Debug]]
|
|
|- style="background-color:#D1BB80;"
|471
| [[VI class/SaveAsInteractive method|SaveAsInteractive]]
|
|
|- style="background-color:#D1BB80;"
|488
| [[VI class/PrepareForCompileAndSave method|PrepareForCompileAndSave]]
|
|
|- style="background-color:#FFFFCC;"
|413
| [[VI class/Save.Run-Time Menu method|Save.Run-Time Menu]]
|Saves the run-time menu to a file specified by <b>Path</b>. This method works only when the VI is running. It saves only menu items with valid tags.
|
|- style="background-color:#D1BB80;"
|41F
| [[VI class/Save.Target Instrument method|Save.Target Instrument]]
|
|
|- style="background-color:#D1BB80;"
|4A0
| [[VI class/Save.Target Instrument For AppBuilder method|Save.Target Instrument For AppBuilder]]
|
|
|- style="background-color:#D1BB80;"
|41A
| [[VI class/Save.To Buffer method|Save.To Buffer]]
|
|X
|- style="background-color:#D1BB80;"
|47D
| [[VI class/Save.VIHierarchyToFolder method|Save.VIHierarchyToFolder]]
|
|
|- style="background-color:#D1BB80;"
|459
| [[VI class/Set Filename method|Set Filename]]
|
|X
|- style="background-color:#D1BB80;"
|472
| [[VI class/Set Is Instance method|Set Is Instance]]
|
|
|- style="background-color:#D1BB80;"
|496
| [[VI class/Set Is Instance No Owner Check method|Set Is Instance No Owner Check]]
|
|
|- style="background-color:#D1BB80;"
|455
| [[VI class/SetOnlineEdit method|SetOnlineEdit]]
|
|X
|- style="background-color:#D1BB80;"
|458
| [[VI class/Set Path method|Set Path]]
|
|
|- style="background-color:#D1BB80;"
|465
| [[VI class/SetVIMod method|SetVIMod]]
|
|
|- style="background-color:#D1BB80;"
|47B
| [[VI class/StatechartInstantiateVI method|StatechartInstantiateVI]]
|
|
|- style="background-color:#D1BB80;"
|43E
| [[VI class/Synch In All Contexts method|Synch In All Contexts]]
|
|X
|- style="background-color:#D1BB80;"
|453
| [[VI class/Tag.Get Tag Names method|Tag.Get Tag Names]]
|
|X
|- style="background-color:#D1BB80;"
|40E
| [[VI class/Tag.Get Tag method|Tag.Get Tag]]
|
|X
|- style="background-color:#D1BB80;"
|40C
| [[VI class/Tag.Remove All Tags method|Tag.Remove All Tags]]
|
|X
|- style="background-color:#D1BB80;"
|40F
| [[VI class/Tag.Remove Tag method|Tag.Remove Tag]]
|
|X
|- style="background-color:#D1BB80;"
|409
| [[VI class/Tag.Remove Tags method|Tag.Remove Tags]]
|
|X
|- style="background-color:#D1BB80;"
|40B
| [[VI class/Tag.Set Persistence method|Tag.Set Persistence]]
|
|X
|- style="background-color:#D1BB80;"
|40D
| [[VI class/Tag.Set Tag method|Tag.Set Tag]]
|
|X
|- style="background-color:#D1BB80;"
|40A
| [[VI class/Tag.Set Tags method|Tag.Set Tags]]
|
|X
|- style="background-color:#CCFFFF;"
|402
| [[VI class/Transaction.Begin Undo method|Transaction.Begin Undo]]
|Begins an undo transaction on a VI.
|
|- style="background-color:#CCFFFF;"
|403
| [[VI class/Transaction.End Undo method|Transaction.End Undo]]
|Ends an undo transaction on a VI.
|
|- style="background-color:#CCFFFF;"
|42A
| [[VI class/Transaction.Fail method|Transaction.Fail]]
|Fails the current transaction and deletes the undo information for the transaction.
|
|- style="background-color:#CCFFFF;"
|490
| [[VI class/Get Redo State method|Get Redo State]]
|Returns whether there is an action to redo and, if so, the text that corresponds to that action.
|X
|- style="background-color:#CCFFFF;"
|489
| [[VI class/Get Undo State method|Get Undo State]]
|Returns whether there is an action to undo and, if so, the text that corresponds to that action.
|X
|- style="background-color:#CCFFFF;"
|429
| [[VI class/Transaction.Redo method|Transaction.Redo]]
|Redoes the last operation. This is similar to selecting <b>Edit&#0187;Redo</b>.
|
|- style="background-color:#CCFFFF;"
|428
| [[VI class/Transaction.Undo method|Transaction.Undo]]
|Undoes the last operation. This method is similar to selecting <b>Edit&#0187;Undo</b>.
|
|- style="background-color:#D1BB80;"
|47C
| [[VI class/TransferVICleanupProc method|TransferVICleanupProc]]
|
|X
|- style="background-color:#D1BB80;"
|432
| [[VI class/User Edits.Allow method|User Edits.Allow]]
|
|X
|- style="background-color:#D1BB80;"
|433
| [[VI class/User Edits.Block method|User Edits.Block]]
|
|X
|- style="background-color:#D1BB80;"
|427
| [[VI class/VI Hier.Get Signature method|VI Hier.Get Signature]]
|
|X
|- style="background-color:#D1BB80;"
|435
| [[VI class/VI Hier.Get User GUID method|VI Hier.Get User GUID]]
|
|X
|- style="background-color:#D1BB80;"
|486
| [[VI class/Remove Generics From VI Hierarchy method|Remove Generics From VI Hierarchy]]
|
|
|- style="background-color:#FFFFCC;"
|421
| [[VI class/VI Icon.Get as Image Data method|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.
 
You also can use the VI Icon:Save to File method to save an image of the VI icon to a file.
 
The clusters returned by this method are similar to the <b>image data</b> output of the Read JPEG File, Read PNG File, and Read BMP File VIs.
|X
|- style="background-color:#D1BB80;"
|4A3
| [[VI class/LoadVIIconManually method|LoadVIIconManually]]
|
|
|- style="background-color:#FFFFCC;"
|418
| [[VI class/VI Icon.Save to File method|VI Icon.Save to File]]
|Saves an image of the VI icon to a file.
 
You also can use the VI Icon:Get As Image Data method to return the VI icon as a cluster of image data.
|
|- style="background-color:#FFFFCC;"
|407
| [[VI class/VI Icon.Set from File method|VI Icon.Set from File]]
|Sets the image of a VI icon from a file. LabVIEW creates a user layer called <b>VI Icon</b> for the image and deletes any other existing icon information from the Icon Editor dialog box.
 
You also can use the VI Icon:Set from Image Data method to set a VI icon from image data you specify.
|
|- style="background-color:#FFFFCC;"
|422
| [[VI class/VI Icon.Set from Image Data method|VI Icon.Set from Image Data]]
|Sets a VI icon from image data you specify. LabVIEW creates a user layer called <b>VI Icon</b> for the image and deletes any other existing icon information from the Icon Editor dialog box.
 
If you want to use a pixmap to set the icon, use the Flatten Pixmap VI to convert the data to an <b>image data</b> cluster before using this method. If you want to use a picture to set the icon, use the Picture to Pixmap VI to convert the data to an <b>image data</b> cluster before using this method. Use the Create Mask VI to make a certain color in the image data transparent before wiring the image data to this method.
|
|- style="background-color:#FFFFCC;"
|3E8
| [[VI class/VI Strings.Export method|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).
 
This method is similar to the <b>Advanced&#0187;Export Strings</b> item on the Tools menu.
|
|- style="background-color:#D1BB80;"
|42B
| [[VI class/VI Strings.Export Private method|VI Strings.Export Private]]
|
|
|- style="background-color:#FFFFCC;"
|3E9
| [[VI class/VI Strings.Import method|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).
 
This method is similar to the <b>Advanced&#0187;Import Strings</b> item on the Tools menu.
|X
|}
</div>


==Events==
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide VI EventsTable</span>
{{VIServerEventsTable|2}}
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ VI Events Table
! Code
! Name
! Type
|- style="background-color:#CCFFFF;"
|1073741887
|[[VI class/BD Selection Change event|BD Selection Change]]
|Filter
|- style="background-color:#D1BB80;"
|1073741895
|[[VI class/DiagNodeSize event|DiagNodeSize]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741847
|[[VI class/Key Down event|Key Down]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483658
|[[VI class/Key Down? event|Key Down?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741848
|[[VI class/Key Repeat event|Key Repeat]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483659
|[[VI class/Key Repeat? event|Key Repeat?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741836
|[[VI class/Key Up event|Key Up]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483680
|[[VI class/Menu Activation? event|Menu Activation?)]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741851
|[[VI class/Menu Selection (App) event|Menu Selection (App)]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741829
|[[VI class/Menu Selection (User) event|Menu Selection (User)]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483654
|[[VI class/Menu Selection? (App) event|Menu Selection? (App)]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741839
|[[VI class/Mouse Enter event|Mouse Enter]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741838
|[[VI class/Mouse Leave event|Mouse Leave]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741849
|[[VI class/Panel Close event|Panel Close]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483651
|[[VI class/Panel Close? event|Panel Close?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741843
|[[VI class/Panel Resize event|Panel Resize]]
|Notify
|- style="background-color:#D1BB80;"
|1073741894
|[[VI class/Start Diagram Drag event|Start Diagram Drag]]
|Notify
|- style="background-color:#D1BB80;"
|1073741860
|[[VI class/VI Will Be Purged event|VI Will Be Purged]]
|Notify
|}
</div>


== History ==
== History ==

Revision as of 02:41, 8 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name VI class
Class ID 2
Scope Basic Development Environment
Class Inheritance

This class is a top-level class.

Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

The VI class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide VI Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
VI Properties Table
Property ID Long Name (English) Description R/W RTE
1F4VI 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.Read/WriteYes (Read Only)
1F5VI PathPath to the VI file.Read OnlyYes (Read Only)
1F6VI 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.Read/WriteYes (Read Only)
1F7History:Entire TextReturns all the text that was added to the VI revision history.Read OnlyNo
1F9Front Panel Window:Title Bar VisibleIndicates whether to display a title bar on the front panel while the VI runs.Read/WriteYes
1FAFront Panel Window:CloseableIndicates whether the close button in the title bar is disabled and the Close item in the File menu is disabled.Read/WriteYes
1FBFront Panel Window:OldResizableRead/WriteYes
1FCFront 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.Read/WriteYes
1FDFront Panel Window:Highlight Return ButtonIndicates whether to highlight Boolean controls that have a shortcut key of <Enter>.Read/WriteYes
1FEFront Panel Window:Size to Screen (Deprecated)Read/WriteYes
1FFFront Panel Window:Auto Center (Deprecated)Read/WriteYes
200Front Panel Window:Show Scroll BarsRead/WriteYes
201Front Panel Window:Show Menu BarIndicates whether to display the menu bar on the front panel while the VI runs.Read/WriteYes
202Tool Bar:VisibleIndicates whether to display the toolbar while the VI runs.Read/WriteYes
203Tool Bar:Show Run ButtonIndicates whether to display the Run button on the toolbar while the VI runs.Read/WriteYes
204Tool Bar:Show Free Run ButtonIndicates whether to display the Run Continuously button on the toolbar while the VI runs.Read/WriteYes
205Tool Bar:Show Abort ButtonIndicates whether to display the Abort Execution button on the toolbar while the VI runs.Read/WriteYes
206Execution: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.Read/WriteYes (Read Only)
208Front Panel Window:Is DialogRead/WriteYes
209Execution:Show Front Panel On LoadIndicates whether to show the front panel when the VI is loaded.Read/WriteYes (Read Only)
20AExecution:Show Front Panel On CallIndicates whether to show the front panel when the VI is called.Read/WriteYes
20BExecution:Close After CallIndicates whether to close the front panel after the VI runs.Read/WriteYes
20CExecution:Run When OpenedIndicates whether to run the VI when it opens.Read/WriteYes (Read Only)
20DExecution:Is ReentrantIndicates whether a VI can be reentrant.Read/WriteYes (Read Only)
20EExecution:PriorityIndicates the priority of the VI when it runs in parallel with other tasks.Read/WriteYes (Read Only)
20FHistory:Use DefaultsIndicates whether to use the global default history or to use the values entered in other history properties.Read/WriteNo
210History:Always Add Comments At SaveIndicates whether to add a comment to the VI revision history every time the VI is saved.Read/WriteNo
211History:Prompt for Comments At CloseIndicates whether to prompt for a VI revision history comment when the VI closes.Read/WriteNo
212History:Prompt for Comments At SaveIndicates whether to prompt for a VI revision history comment when the VI is saved.Read/WriteNo
213History: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.Read/WriteNo
214Help:Document TagIndex keyword or HTML filename for a topic in the compiled help file to which the VI is linked.Read/WriteYes
215Help: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.Read/WriteYes
216Front Panel Window:OpenRead/WriteYes
217Front 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).Read/WriteYes
218Front 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).Read/WriteYes
219Modifications:VI Modifications Bitset OldRead OnlyYes
21AModifications: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.Read OnlyYes (Read Only)
21BModifications: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.Read OnlyNo
21CMetrics:Code SizeAmount of memory used for VI code in bytes.Read OnlyYes (Read Only)
21DMetrics:Total Data SizeAmount of memory allocated for data in bytes.Read OnlyYes (Read Only)
21EMetrics:Size of Front PanelSize of the front panel in bytes.Read OnlyYes (Read Only)
21FMetrics:Size of Block DiagramSize of the block diagram in bytes.Read OnlyYes (Read Only)
220Callers' NamesReturns a list of all the loaded VIs that call the referenced VI.Read OnlyYes (Read Only)
221Callees' NamesRead OnlyYes
225Auto Logging:Log File PathPath of the datalog file in which front panel data and a time stamp are written.Read/WriteYes
226Auto Logging:Log at FinishIndicates whether to write front panel values to a datalog file after the VI runs.Read/WriteYes
227Auto Logging:Print at FinishIndicates whether to print the front panel after the VI runs.Read/WriteYes
228Front Panel Window:OriginRead/WriteYes
229Front Panel Window:TitleString that appears in the title bar. This string does not have to match the VI filename.Read/WriteYes
22AConnector Pane:SetSets the connector pane of the VI to match the connector pane of the VI reference input.Write OnlyNo
22BExecution:Suspend On CallIndicates whether LabVIEW suspends the execution of the VI when calling it as a subVI. Use this property carefully with reentrant VIs.Read/WriteYes (Read Only)
22CFront 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).Read/WriteYes
22DExecution:StateIndicates the execution state of the VI.Read OnlyYes (Read Only)
22EEdit 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.Read/WriteYes
22FExecution:Preferred Exec SystemIndicates the execution system in which the VI runs.Read/WriteYes (Read Only)
230Modifications:User ChangesRead OnlyNo
231Front Panel Window:Custom TitleIndicates whether the VI has a custom title string. Write FALSE to remove the custom title string.Read/WriteYes
232VI TypeIndicates the type of VI.Read OnlyYes (Read Only)
234History:Revision NumberCurrent revision number of the VI.Read/WriteNo
235Connector Pane:Data (Deprecated)Read OnlyYes
236Metrics:AdvancedRead OnlyNo
237Block Diagram Window:OpenOpens or closes the block diagram window.Read/WriteNo
238Block Diagram Window:Window BoundsGets or sets the bounds for a block diagram window.Read/WriteNo
239Connector Pane:Old Type DescriptorRead OnlyYes
23ATool Kit AttrRead/WriteNo
23BFront Panel RefNum TDRead OnlyNo
23CBlock DiagramReturns a reference to the block diagram of the VI. This property is not available in stand-alone applications.Read OnlyNo
23DFront PanelReference to the front panel of a VI.Read OnlyYes (Read Only)
23EConnector Pane:ReferenceReturns a reference to the connector pane of the VI.Read OnlyYes (Read Only)
23FFront 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.Read/WriteYes
240Modifications:VI SignaturesRead OnlyYes
241Is InstanceReturns whether or not the VI is an Express VI instance.Read/WriteNo
242Automatic Error HandlingIf TRUE, enables automatic error handling for a VI.Read/WriteNo
243Block Diagram Window:OriginGets or sets the vertical and horizontal coordinates in the upper left-hand corner of the block diagram.Read/WriteNo
244Run-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.Read/WriteYes
245Front Panel Window:Is FloatingRead/WriteYes
246RunVILocalRead/WriteYes
247Front Panel Window:MinimizableIndicates whether the user can minimize the front panel window while the VI runs.Read/WriteYes
248Front Panel Window:ResizableIndicates whether the user can resize the front panel window while the VI runs.Read/WriteYes
249Expand When Dropped As SubVIExpands to show terminals when dropped as a subVI.Read/WriteNo
24APrinting:Page OrientationGets or sets the page orientation to use when printing the VI.Read/WriteYes
24BPrinting: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.Read/WriteYes
24CPrinting:Front Panel Scaling?If TRUE, LabVIEW scales the front panel to fit on the printed page.Read/WriteYes
24DPrinting:MarginsGets or sets the page margins to use when printing the VI in inches or centimeters.Read/WriteYes
24EPrinting: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.Read/WriteYes
250Printing: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.Read/WriteYes
251Printing: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.Read/WriteYes
252Printing: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.Read/WriteYes
253Printing: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.Read/WriteYes
254Printing: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.Read/WriteYes
255PurgativeRead/WriteYes
256Control VI TypeSpecifies whether a control VI is a control, a typedef, or a strict typedef. This property is valid for control VIs only.Read/WriteYes (Read Only)
257VI Linker ErrorsRead OnlyYes
258Hide Instance VI Caption On DropRead/WriteNo
259Front 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).Read/WriteYes
260Front Panel Window:StateCurrent state of the front panel window.Read/WriteYes
262Printing:Block Diagram Scaling?If TRUE, LabVIEW scales the block diagram to fit on the printed page.Read/WriteYes
263Suppress Instance VI HaloRead/WriteYes
264Is System VIRead/WriteYes
265Front 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.Read/WriteYes
266Connector Pane:Checksum v1 (Deprecated)Read OnlyYes
267Front Panel Window:OS WindowRead OnlyYes
268Block Diagram Window:OS WindowRead OnlyNo
269Modifications:VI User Code GUIDRead OnlyYes
26AIs ProbeReturns TRUE if the VI is running as a probe and the probe VI is open.Read OnlyNo
26BSuppress Data ManagerRead/WriteYes
26CSuppress Transact InfoRead/WriteYes
26DExecution:Retain Wire ValuesRead/WriteNo
26EIs XNode VIRead/WriteYes
26FOwning ApplicationReturns a reference to the application that owns the VI. Be sure and close this reference afterward.Read OnlyYes (Read Only)
271Front Panel Window:WindowRead OnlyYes
272Block Diagram Window:WindowRead OnlyNo
273Front 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.Read/WriteYes
274Front 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.Read/WriteYes
275Front 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.Read/WriteYes
276LibraryReturns 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.Read OnlyNo
277Context:Has Edits In Another ContextRead OnlyYes
278Context:Has Edits In This ContextRead OnlyYes
279Context:Is Reserved In Other ContextRead OnlyYes
27AContext:Is Reserved In This ContextRead OnlyYes
27BHelp:Examples ExistRead/WriteNo
27CBD Master WizardRead OnlyNo
27DConnector 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.Read OnlyYes (Read Only)
27EOverload InfoRead/WriteNo
27FConnector Pane:Checksum v2 (Deprecated)Read OnlyYes
280Callees' PathsRead OnlyYes
281Callers' PathsRead OnlyYes
282VI Compile TimeRead OnlyNo
283Auto 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.Read/WriteYes
284No Clone If Instance VIRead/WriteYes
285VI Clone NameName of the clone of a reentrant VI. Returns an error if the VI is not a clone.Read OnlyYes
286Is Clone VIReturns TRUE if the VI is a clone of a reentrant VI.Read OnlyYes
287Suppress Type PropRead/WriteNo
288Execution:Reentrancy TypeIndicates the type of reentrancy LabVIEW uses for a reentrant VI.Read/WriteYes (Read Only)
289Statechart:Supress ParseRead/WriteNo
28AStatechart:Is Sub Panel EditableRead/WriteYes
28BC Code Generation:Generate Guard CodeRead/WriteYes
28CC Code Generation:Generate Serial OnlyRead/WriteYes
28DC Code Generation:Generate Integer OnlyRead/WriteYes
28EC Code Generation:Generate C Function CallsRead/WriteYes
28FC Code Generation:Use Stack VariablesRead/WriteYes
290Item IDRead/WriteYes
291Metrics: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.Read OnlyYes
292Metrics: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.Read OnlyYes
293Library:VersionRead OnlyYes
294C Code Generation:Expression FoldingRead/WriteYes
295Library:PrivateRead OnlyNo
296Is SkinnedRead/WriteYes
297Block Diagram Window:StateCurrent state of the block diagram window.Read OnlyYes
298Modifications: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.Read OnlyYes (Read Only)
299Ladder VI Needs ScriptingRead/WriteYes
29BC Code Generation:Inline SubVIRead/WriteYes
29CDo Not Show Save Changes DialogRead/WriteNo
29FFront Panel Window:Native WindowRead OnlyYes
2A0Block Diagram Window:Native WindowRead OnlyNo
2A1Front Panel Window:Window InterfaceRead OnlyYes
2A2Block Diagram Window:Window InterfaceRead OnlyNo
2A3Is GenericRead OnlyYes
2A4Is 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.Read OnlyNo
2A5Number of Non-Proxy CallersRead OnlyYes
2A6Compiler:Generated Code Profiling SettingsRead/WriteNo
2A7Compiler:Generated Code Profiling ResultRead OnlyNo
2A8Contains Compiled CodeSets or returns whether the VI includes compiled code.Read/WriteYes (Read Only)
2A9Is In Packed LibraryReturns TRUE if a packed project library contains the VI.Read OnlyYes
2AAExecution:Inline SubVISpecifies whether to inline the subVI into its calling VIs.Read/WriteNo
2ABExecution:Inline Is AllowedReturns TRUE if you can inline this subVI into its calling VIs.Read OnlyNo
2ACExecution:SSE Runtime OptimizationRead/WriteNo
2ADHas MathScript NodesRead OnlyNo
2AEExecution:Inline SubVI If PossibleRead/WriteNo
2AFExecution:Compiled With SSERead OnlyYes
2B0Terminal 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.Read OnlyYes
2B1Tagged And Not EditedRead/WriteNo
2B2Connector Pane:Checksum Ignore Dynamic Dispatch v1 (Deprecated)Read OnlyYes
2B3Compiled: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.Read OnlyYes
2B4Compiled: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.Read OnlyYes
2B5Inline CalleesRead OnlyYes
2B6Library:VersionReturns the version of the library that contains the VI you specify.Read OnlyYes
2B7Metrics:Number of clonesRead OnlyYes
2B8Execution:Inline EnumRead/WriteNo
2B9Execution:Did Compiler Or User Approve InliningRead OnlyNo
2BAHelp:Document Web URLURL for the web-based help topic to link to a VI from the Detailed help link in the Context Help window.Read/WriteYes
2BBHelp:Use Web URLIndicates whether to link to a web-based help file from the Detailed help link in the Context Help window for a VI.Read/WriteYes
2BCExecution:Shrink Large BuffersRead/WriteYes
2BDIs Running InteractivelyRead OnlyYes
2BEExecution:Shrink Large Buffer ThresholdRead/WriteYes
2BFExecution highlighting?Read/WriteNo
2C1Did Recompile InThis VersionRead OnlyYes
2C2Saved VersionRead OnlyYes
2C3Front Panel Window:Alignment Grid SizeRead/WriteNo
2C4Block Diagram Window:Alignment Grid SizeRead/WriteNo
2C5Connector Pane:Checksum v3Read OnlyYes
2C6Connector Pane:Checksum Ignore Dynamic Dispatch v2Read OnlyYes


Methods

Show/Hide VI Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
VI Methods Table
Method ID Long Name (English) Description RTE
3E8VI Strings:ExportExports 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).No
3E9VI Strings:ImportImports 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).Yes (Read/Write)
3EASave:InstrumentSaves a VI that is not currently running and synchronizes the VI with the edited version in other application instances before saving.No
3EBRun VIStarts 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.Yes (Read/Write)
3ECAbort VIAborts the execution of a top-level VI.Yes (Read/Write)
3EDPrint:VI To PrinterPrints the VI information to a printer.Yes (Read/Write)
3EEPrint:VI To HTMLSaves 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.No
3EFPrint:VI To RTFSaves the VI information to an RTF file.No
3F0Print:VI To TextSaves 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.No
3F1Control Value:Set [Flattened] (Deprecated)Yes
3F2Control Value:Get [Flattened] (Deprecated)Yes
3F3Default Values:Make Current DefaultChanges the defaults of all controls on the front panel to be the current values. This method is available only in edit mode.No
3F4Default Values:Reinitialize All To DefaultChanges the current values of all controls on the front panel to their defaults.Yes (Read/Write)
3F8Front Panel:Old Get ImageYes
3FARevert VIDiscards changes and reloads a VI from disk.No
3FBPrint:Panel To PrinterPrints 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.Yes (Read/Write)
3FCControl Value:Get All [Flattened] (Deprecated)Yes
3FDLock State:GetReturns the lock state of the VI and indicates whether the password for the VI is in the password cache.Yes (Read/Write)
3FELock State:SetSets 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.No
3FFSave:Instrument (Private)No
400Save:For PreviousSaves a copy of the VI that is readable by LabVIEW version 8.0 and later. If you save a password-protected VI for a previous LabVIEW version, you must enter the password. You can enter the password programmatically as an input on the Open VI Reference function.No
401EmptyEmpties the front panel and block diagram of the VI.No
402Transaction:Begin UndoBegins an undo transaction on a VI.No
403Transaction:End UndoEnds an undo transaction on a VI.No
404Set Front Panel Scaling ModeYes
405Get Front Panel Scaling ModeYes
407VI Icon:Set From FileSets the image of a VI icon from a file. LabVIEW creates a user layer called VI Icon for the image and deletes any other existing icon information from the Icon Editor dialog box.No
408Front Panel:Open In WindowYes
409Tag:Remove TagsYes
40ATag:Set TagsYes
40BTag:Set PersistenceYes
40CTag:Remove All TagsYes
40DTag:Set TagYes
40ETag:Get TagYes
40FTag:Remove TagYes
410Block Diagram:Remove Bad WiresRemoves all the broken wires on the block diagram of the VI.No
411Fake Exec StateYes
412Generate VHDLNo
413Save:Run-Time MenuSaves 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.No
414Disconnect Polys And TypedefsNo
415Print:Panel To PostScriptPrints the panel of the VI to the specified PostScript file.Yes (Read/Write)
416Export Interface (Deprecated)Yes
417Create Constant or ControlYes
418VI Icon:Save To FileSaves an image of the VI icon to a file.No
419Clear HistoryClears the revision history of the referenced VI.No
41ASave:To BufferYes
41BControl Value:SetSets 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.Yes (Read/Write)
41CControl Value:GetGets 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.Yes (Read/Write)
41DControl Value:Get AllGets 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.Yes (Read/Write)
41EReplicate Conpane (Old Type Desc)Yes
41FSave:Target InstrumentNo
420Block Diagram:Open In WindowYes
421VI Icon:Get As Image DataReturns 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.Yes (Read/Write)
422VI Icon:Set From Image DataSets a VI icon from image data you specify. LabVIEW creates a user layer called VI Icon for the image and deletes any other existing icon information from the Icon Editor dialog box.No
423Front Panel:Get ImageReturns 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.Yes (Read/Write)
424Front Panel:Old OpenYes
425Front Panel:CloseCloses the front panel window.Yes (Read/Write)
426Front Panel:Get Image ScaledReturns 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.Yes (Read/Write)
427VI Hierarchy:Get SignatureYes
428Transaction:UndoUndoes the last operation. This method is similar to selecting Edit»Undo.No
429Transaction:RedoRedoes the last operation. This is similar to selecting Edit»Redo.No
42ATransaction:FailFails the current transaction and deletes the undo information for the transaction.No
42BVI Strings:Export PrivateNo
42CBlock Diagram:Get Image ScaledReturns 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.No
42DGet Conpane ImageReturns the connector pane image, as it appears in the Context Help window, 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.Yes (Read/Write)
42ERemote Panel:Lock ControlReturns 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.Yes (Read/Write)
42FRemote Panel:Unlock ControlIf 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.Yes (Read/Write)
430Remote Panel:Client ConnectionsReturns an array of clusters containing connection information about the clients viewing or controlling the VI.Yes (Read/Write)
431Remote Panel:Close Connection To ClientCloses a remote front panel connection to a client.Yes (Read/Write)
432User Edits:AllowYes
433User Edits:BlockYes
434Front Panel:Set Close If LonelyYes
435VI Hierarchy:Get User GUIDYes
436Generate C CodeYes
437Cause Type PropagationYes
438Front Panel:OpenOpens 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.Yes (Read/Write)
439Block Diagram:Set ModNo
43AFront Panel:Set ModNo
43BAdapt Nodes PrivateNo
43CAdapt NodesAllows LabVIEW to replace overloaded nodes with more appropriate implementations. For example, if you script an Add function and wire a Matrix control to it, LabVIEW breaks the wire. If you call Adapt Nodes, the Add function might be replaced with a Matrix Add VI. Operator overloading will not occur during scripting. You must call this method for Overloading to happen.No
43ESynchronize In All ContextsYes
43FEnter TextYes
440Generate C Code VariantYes
441Front Panel:CenterSpecifies whether to automatically center the front panel window on the computer screen.Yes (Read/Write)
442Set Is Instance (Deprecated)No
443Create from ReferenceCreates a constant or control using a constant or control reference as a template.No
444Create from Data Type (Deprecated)Creates a control or constant of the data type you specify. LabVIEW always creates a control initially, even if you configure Style to create a constant or indicator. To change the type of the new object, use the Indicator property.No
445Front Panel:Run-Time Position:Get PositionReturns the default position of the front panel window at run-time.Yes (Read/Write)
446Front Panel:Run-Time Position:UnchangedConfigures the VI to maintain the position of its front panel window when the VI runs.Yes (Read/Write)
447Front Panel:Run-Time Position:CenteredConfigures the referenced VI to center its front panel every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.Yes (Read/Write)
448Front Panel:Run-Time Position:MaximizedConfigures a VI to maximize its front panel every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.Yes (Read/Write)
449Front Panel:Run-Time Position:MinimizedSets a VI to minimize its front panel every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.Yes (Read/Write)
44AFront Panel:Run-Time Position:CustomConfigures the referenced VI to open its front panel in a custom position every time the VI runs. If the VI is running when you call this method, the change does not take effect until the next time the VI runs.Yes (Read/Write)
44BDisconnect From LibraryDisconnects a VI that a LabVIEW project library owns from the owning project library.No
44CSet VI Mod (Deprecated)No
44DReplicate ConpaneMake the connector pane of the VI Reference match the given connector pane.Yes (Read/Write)
44EAdd To AutoSave Pending ListNo
44FRemove BreakpointsYes
450Save:Hierarchy for PreviousYes
451Save:Instrument (No Sync)No
452Get ErrorsYes
453Tag:Get NamesYes
454Give Temporary Unsaved NameNo
455Set Online EditYes
457Control VI Apply ChangesYes
458Set PathNo
459Set FilenameYes
45ASave:Copy As SystemYes
45CSave:Instrument and Callers DebugNo
45DInvoke Built in Menu Item (Not Implemented)Yes
45EBegin Scripting (Not Implemented)Yes
45FEnd Scripting (Not Implemented)Yes
460Move ObjectsMoves the objects by the offset amount of pixels.No
461Get Menu Item State (Not Implemented)Yes
462Backup:Suppress (Not Implemented)Yes
463Backup:Unsuppress (Not Implemented)Yes
464Find Control with Key FocusReturn 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.Yes (Read/Write)
465Set VI ModNo
466Compile:VICompiles the VI and optionally the entire VI hierarchy of that VI.Yes (Read/Write)
467Run VI And DeployYes
468Deploy VIYes
469LadderVI Clear Ladder EditorYes
46AControl Value:Get DefaultYes
46BControl Value:Get Array Element DefaultYes
46CGet Named Instance VIYes
46DCode Coverage:ResetNo
46ECode Coverage:PercentageNo
46FCode Coverage:Uncovered DiagramsNo
470Control Value:Get TypeYes
471Save:InteractiveNo
472Set Is InstanceNo
473Refresh Error Window EntryYes
474Block Diagram:Clean UpCleans 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.Yes (Read/Write)
477Front Panel:Open In Native WindowYes
478Block Diagram:Open In Native WindowYes
479Detect Parallel LoopsDetects parallel loops in the VI.Yes (Read/Write)
47AGet VI Dependencies (Names and Paths)This method returns the names and paths of the VI dependencies of a VI. You can use this method to return a specific subset of the total set of VI dependencies of a VI. This method does not return non-VI dependencies, such as project libraries, XControls, classes, and statecharts.Yes (Read/Write)
47BState Chart Instantiate VINo
47CTransfer VI Cleanup ProcYes
47DSave:VI Hierarchy to FolderNo
47ELibrary:Get Previous VI from LibraryYes
47FLibrary:Get Next VI from LibraryYes
480Pause VIPauses or unpauses the VI execution.No
481Debugging:Step IntoSingle-steps through a VI to help you debug the VI. To use this method, the VI must be paused.Yes (Read/Write)
482Debugging:Step OverSingle-steps through a VI to help you debug the VI. To use this method, the VI must be paused.Yes (Read/Write)
483Debugging:Step OutSingle-steps through a VI to help you debug the VI. To use this method, the VI must be paused.Yes (Read/Write)
484Debugging:Get Debug Button Display StateReturns TRUE if the button is enabled or FALSE if the button is grayed out. This method also returns the string for the tip strip associated with the button. For example, this method might return Step into For Loop for the Step Into button.Yes (Read/Write)
485Copy VI Hierarchy With FPGA Side EffectsNo
486VI Hierarchy:Remove Generic From VI HierarchyNo
488Save:Prepare For Compile And SaveNo
489Transaction:Get Undo StateReturns whether there is an action to undo and, if so, the text that corresponds to that action.Yes (Read/Write)
490Transaction:Get Redo StateReturns whether there is an action to redo and, if so, the text that corresponds to that action.Yes (Read/Write)
491Compile:Compile To DFIR XML (Not Implemented)Yes
492Reset Generated Code Profile ResultsNo
493Compile:Compile To DFIR CPPNo
494License:Get License StatusYes
495Get Compile MetricsReturns a string that describes transform metrics from the most recent compile of the VI, if metric recording was enabled.Yes (Read/Write)
496Set Is Instance No Owner CheckNo
49BGet Library Access ScopeReturns the access scope or inherited access scope of this VI if it is owned by a LabVIEW project library. This method provides the same information as the method Source Scope:Get of the Project Library class without requiring a reference to the owning project library.No
49CLibrary:Has Library?Yes
49DCreate from Data TypeCreates a control or constant of the data type you specify. LabVIEW always creates a control initially, even if you configure Style to create a constant or indicator. To change the type of the new object, use the Indicator property.No
49EGet CallPaths To Other VIYes
49FCheck AppBuilderCacheNo
4A0Save:Target Instrument For AppBuilderNo
4A1Control Value:Set MultipleYes
4A2Populate Asynchronous Call PoolEnsures that the asynchronous call pool for a VI reference contains at least the number of data spaces specified by the Minimum Size parameter. By default, when you open a reference with the Open VI Reference function, LabVIEW allocates one data space per CPU core on the development computer.Yes (Read/Write)
4A3VI Icon:Load VI Icon ManuallyNo
4A4Export InterfaceYes
4A5Attempt Setting Disconnect From Callers NeededNo
4A6GetXMLDataTypesYes
4A7Get Control Index by NameGets the index for the control or indicator of the given name. If the control or indicator for which you want to get an index does not have a terminal on the block diagram, this method returns an error.Yes (Read/Write)
4A8Get VI BookmarksReturns the bookmark information for the specified VI reference. You must load the VI into memory in order to read the bookmark information. This method returns an error if the VI is password protected or if the VI does not have a block diagram.Yes (Read/Write)
4A9Get ObjectRef From BookmarkIDReturns a reference to the object, such as the label, that contains the bookmark.Yes (Read/Write)
4AAGet AppBuilder Source ChecksumNo
4ABInternalStatsYes
4ACGet Missing Dependencies InformationYes
4ADContains LinkRefNo
4AEClear TypeCast LinkRefsNo
4AFGet UDClass LinkRefsNo
4B0Configure Panel As Top-Level HiddenNo
4B1GetAllHierarchyRefersYes


Events

Show/Hide VI Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
VI Events Table
Code Name Description Type
1073741895DiagNodeSize
1073741847Key DownGenerated when the user performs keystrokes on the keyboard.Notify
2147483658Key Down?Generated when the user performs keystrokes on the keyboard.Filter
1073741848Key RepeatGenerated at regular intervals when the user presses and holds a key anywhere on the front panel.Notify
2147483659Key Repeat?Generated at regular intervals when the user presses and holds a key anywhere on the front panel.Filter
1073741836Key UpGenerated when the user releases a key on the keyboard.Notify
2147483680Menu Activation?
1073741851Menu Selection (App)Generated when the user selects an application item from the LabVIEW menu, such as Help»Show Context Help. Use the Menu Selection (User) event to generate an event when the user selects a user-defined menu item.Notify
2147483654Menu Selection? (App)Generated when the user selects an application item from the LabVIEW menu, such as Help»Show Context Help.Filter
1073741829Menu Selection (User)Generated when the user selects a user-defined item from the LabVIEW menu. Use the Menu Selection (App) event to generate an event when the user selects an application menu item.Notify
1073741839Mouse EnterGenerated when the cursor enters the bounds of the front panel.Notify
1073741838Mouse LeaveGenerated when the cursor leaves the bounds of the front panel.Notify
1073741849Panel CloseGenerated when the user tries to interactively close the front panel of a VI by selecting the Close item in the File menu or by clicking the close glyph on the window border.Notify
2147483651Panel Close?Generated when the user tries to interactively close the front panel on a VI by selecting the Close item in the File menu or by clicking the close glyph on the window border.Filter
1073741843Panel ResizeGenerated when the user sizes the front panel by clicking and dragging the window frame, minimizes or maximizes the front panel, or restores the front panel to its original size from a maximized or minimized state.Notify
1073741894Start Diagram Drag
1073741860VI Will Be Purged


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=VI_class&oldid=9633"