VI class

From LabVIEW Wiki
Jump to: navigation, search
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


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

Version Change(s)
LabVIEW 2018 More info to come.

See Also