VI class
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/W | Readable/Writable Permissions |
RTE | Available in the Run-Time Engine |
Basic Development Environment | |
VI Scripting | |
Private | |
Deprecated |
Property ID | Short Name (English) | Description | R/W | RTE |
---|---|---|---|---|
225 | AutoLog.Path | Path of the datalog file in which front panel data and a time stamp are written.
Note 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 |
226 | AutoLog.AtFinish | Indicates whether to write front panel values to a datalog file after the VI runs.
This method is similar to the Log at Completion item on the Operate menu. Note 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 |
227 | AutoLog.PrintAtFinish | Indicates whether to print the front panel after the VI runs.
This method is similar to the Automatically print front panel every time VI completes execution option on the Print Options page of the VI Properties dialog box and the Print at Completion item in the Operate Menu. |
R/W | X |
283 | AutoPreallocate | Get or set the Autopreallocate arrays and strings setting on VIs. This is used by the FPGA module to optimize array and string operations by forcing LabVIEW to preallocate memory at compile time rather than dynamically allocating memory at run time.
This property is similar to the Autopreallocate arrays and strings checkbox on the Execution Page of the VI Properties dialog box. |
R/W | X |
242 | 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 Enable automatic error handling in new VIs option on the Block Diagram page of the Options dialog box and the Enable automatic error handling option on the Execution page of the VI Properties dialog box.
|
R/W | |
27C | BDMasterWizard | R | ||
23C | Diagram | Returns a reference to the block diagram of the VI. This property is not available in stand-alone applications. | R | |
2C4 | BD Align Grid Size | R/W | ||
2A0 | BDWin.NativeWindow | R | ||
237 | BDWin.Open | Opens or closes the block diagram window. | R/W | |
243 | BDWin.Origin | Gets or sets the vertical and horizontal coordinates in the upper left-hand corner of the block diagram. | R/W | |
297 | BD.State | Current state of the block diagram window. | R | X |
238 | BDWin.Bounds | Gets or sets the bounds for a block diagram window. | R/W | |
2A2 | BDWin.WindInterface | R | ||
220 | Callers | Returns a list of all the loaded VIs that call the referenced VI.
This property is similar to the This VI's Callers item in the View Menu. |
R | X |
281 | CallersPaths | R | X | |
2B3 | Compiled.CodeComplexity | Returns 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.
This property provides programmatic access to the Compiled Code Complexity field on the Memory Usage page of the VI Properties dialog box.
Possible Errors This property returns error 1000 if the referenced VI has never been compiled. |
R | X |
2B4 | 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 Last compiled with 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.
|
R | X |
2A7 | Compiler.GencodeProfilingResult | R | ||
2A6 | Compiler.GencodeProfilingSettings | R/W | ||
2C6 | ConPane.CRC Ignore DD v2 | R | X | |
2C5 | ConPane.CRC v3 | R | X | |
27D | 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 |
23E | ConPane.Ref | Returns a reference to the connector pane of the VI. | R | X |
22A | 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 | |
2A8 | 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 Separate compiled code from source file option on the General page of the VI Properties dialog box. |
R/W | X |
277 | HasEditsInAnotherContext | R | X | |
278 | HasEditsInThisContext | R | X | |
279 | IsReservedInOtherContext | R | X | |
27A | IsReservedInThisContext | R | X | |
256 | 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 |
2C1 | DidRecompileInThisVersion | R | X | |
29C | DoNotShowSaveChangesDialog | R/W | ||
22E | 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 |
2BF | Highlight? | R/W | ||
206 | 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 Allow debugging option on the Execution page of the VI Properties dialog box. Note 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 |
20B | Exec.CloseFPAfterCall | Indicates whether to close the front panel after the VI runs.
Note Use this property in conjunction with the Show Front Panel On Call property. |
R/W | X |
2AF | Exec.CompiledWithSSE | R | X | |
2B9 | Exec.DidCompilerOrUserApproveInlining | R | ||
2B8 | Exec.InlineSubVIEnum | R/W | ||
2AB | Exec.InlineIsAllowed | Returns TRUE if you can inline this subVI into its calling VIs. | R | |
2AA | Exec.InlineSubVI | Specifies whether to inline the subVI into its calling VIs. | R/W | |
2AE | Exec.InlineSubVIIfPossible | R/W | ||
20D | Exec.IsReentrant | Indicates whether a VI can be reentrant. | R/W | X |
22F | Exec.PrefSys | Indicates the execution system in which the VI runs. | R/W | X |
20E | Exec.Priority | Indicates the priority of the VI when it runs in parallel with other tasks.
This property is similar to the Priority option on the Execution page of the VI Properties dialog box. |
R/W | X |
288 | 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 |
26D | Exec.RetainWireValues | R/W | ||
20C | Exec.RunOnOpen | Indicates whether to run the VI when it opens.
This property is similar to the Run when opened option on the Execution page of the VI Properties dialog box. Note 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 |
2AC | Exec.SSERuntimeOptimization | R/W | ||
20A | Exec.ShowFPOnCall | Indicates whether to show the front panel when the VI is called.
This property is similar to the Show front panel when called option on the Customize Window Appearance dialog box and the Show front panel when called option on the SubVI Node Setup dialog box. |
R/W | X |
209 | Exec.ShowFPOnLoad | Indicates whether to show the front panel when the VI is loaded.
This property is similar to the Show front panel when loaded option on the Customize Window Appearance dialog box and the Open front panel when loaded option on the SubVI Node Setup dialog box. Note 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 |
2BE | Exec.ShrinkLargeBuffersThreshold | R/W | X | |
2BC | Exec.ShrinkLargeBuffers | R/W | X | |
22D | Exec.State | Indicates the execution state of the VI. | R | X |
22B | 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 Suspend when called option on the Execution page of the VI Properties dialog box, the Suspend when called option on the SubVI Node Setup dialog box, and the Suspend when Called item on the Operate menu. |
R/W | X |
249 | Expand SubVI | Expands to show terminals when dropped as a subVI. | R/W | |
23D | Panel | Reference to the front panel of a VI. | R | X |
23B | FPRefNumTD | R | ||
2C3 | FP Align Grid Size | R/W | ||
1FC | 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 |
259 | 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 Window Behaviorsection in the Customize Window Appearance dialog box. |
R/W | X |
1FA | FP.Closeable | Indicates whether the close button in the title bar is disabled and the Close item in the File 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 |
231 | FP.CustomTitle | Indicates whether the VI has a custom title string. Write FALSE to remove the custom title string. | R/W | X |
1FD | FP.HiliteReturnBut | Indicates whether to highlight Boolean controls that have a shortcut key of . | R/W | X |
245 | FP.IsFloating | R/W | X | |
217 | 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 |
23F | 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 Maintain proportions of window for different monitor resolutions option on the Window Size page of the VI Properties dialog box. |
R/W | X |
247 | 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 Allow user to minimize window checkbox in the Customize Window Appearance dialog box. |
R/W | X |
265 | 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 Minimum Panel Size section of the Window Size page of the VI Properties dialog box. Elements:
|
R/W | X |
275 | 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 Monitor option on the Window Run-Time Position page of the VI Properties dialog box. |
R/W | X |
29F | FP.NativeWindow | R | X | |
22C | 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:
|
R/W | X |
248 | 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 Allow user to resize window checkbox in the Customize Window Appearance dialog box. |
R/W | X |
274 | 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 Window Runs Transparently option in the Customize Window Appearance dialog box. |
R/W | X |
201 | 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.
|
R/W | X |
260 | 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 |
229 | 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 Window title option on the Window Appearance page of the VI Properties dialog box. |
R/W | X |
1F9 | 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 Window has title bar option on the Customize Window Appearance dialog box. |
R/W | X |
273 | 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 Window Runs Transparently option in the Customize Window Appearance dialog box. |
R/W | X |
218 | 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
|
R/W | X |
2A1 | FP.WindInterface | R | X | |
2AD | HasMSN | R | ||
215 | 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 Help Path text box on the Documentation page of the VI Properties dialog box. |
R/W | X |
214 | 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 Help Tag text box on the Documentation page of the VI Properties dialog box. |
R/W | X |
2BA | Help.WebURL | URL for the web-based help topic to link to a VI from the Detailed help 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 Context Help window. |
R/W | X |
27B | Help.Examples | R/W | ||
2BB | Help.UseWebURL | Indicates whether to link to a web-based help file from the Detailed help 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 |
258 | Hide Inst VI Caption | R/W | ||
210 | 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 | |
1F7 | Hist.Text | Returns all the text that was added to the VI revision history. | R | |
211 | 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 | |
212 | 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 | |
213 | 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 Record comments generated by LabVIEW option on the Revision History page of the VI Properties dialog box. |
R/W | |
234 | 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 Next Revision option in the History window. |
R/W | |
20F | 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 Use the default history settings from the Options dialog box option in the Revision History page of the VI Properties dialog box. You can specify the global default history in the VI Properties dialog box. |
R/W | |
2B5 | Inline Callees | R | X | |
286 | IsCloneVI | Returns TRUE if the VI is a clone of a reentrant VI. | R | X |
2A3 | IsGeneric | R | X | |
2A9 | IsInPackedLibrary | Returns TRUE if a packed project library contains the VI. | R | X |
241 | IsInstance | Returns whether or not the VI is an Express VI instance. | R/W | |
26A | IsProbe | Returns TRUE if the VI is running as a probe and the probe VI is open. | R | |
2BD | IsRunningInteractively | R | X | |
296 | IsSkinned | R/W | X | |
264 | IsSystemVI | R/W | X | |
2A4 | 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 | |
26E | IsXNodeVI | R/W | X | |
290 | ItemID | R/W | X | |
299 | LadderVINeedsScripting | R/W | X | |
276 | 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 | |
295 | LibraryPrivate | R | ||
2B6 | Library.Version | Returns the version of the library that contains the VI you specify. | R | X |
236 | Metric.Adv | R | ||
292 | 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 |
21C | Metric.CodeSize | Amount of memory used for VI code in bytes.
This property is similar to the Code option on the Memory Usage page of the VI Properties dialog box. |
R | X |
291 | 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 |
2B7 | Metric.NumberOfClones | R | X | |
21F | Metric.BDSize | Size of the block diagram in bytes.
This property is similar to the Block Diagram Objects option on the Memory Usage page of the VI Properties dialog box. |
R | X |
21E | Metric.FPSize | Size of the front panel in bytes.
This property is similar to the Front Panel Objects option on the Memory Usage page of the VI Properties dialog box. |
R | X |
21D | 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 Data option on the Memory Usage page of the VI Properties dialog box. |
R | X |
21B | 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 | |
21A | 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 |
230 | Mods.UserChanges | R | ||
298 | 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 |
240 | Mods.VISignature | R | X | |
269 | Mods.VIUserCodeGUID | R | X | |
284 | NoCloneIfInstanceVI | R/W | X | |
2A5 | NonProxyCallers | R | X | |
27E | OverloadInfo | R/W | ||
26F | OwningApp | Returns a reference to the application that owns the VI. Be sure and close this reference afterward. | R | X |
262 | Printing.BDScaling? | If TRUE, LabVIEW scales the block diagram to fit on the printed page.
This property is similar to the Scale printed block diagram to fit page checkbox on the Print Options page of the VI Properties dialog box and the Scale block diagram to fit option on the Printer page of the Print dialog box. |
R/W | X |
24C | Printing.FPScaling? | If TRUE, LabVIEW scales the front panel to fit on the printed page.
This property is similar to the Scale printed front panel to fit page checkbox on the Print Options page of the VI Properties dialog box and the Scale front panel to fit option on the Printer page of the Print dialog box. |
R/W | X |
250 | 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 |
251 | 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 |
252 | 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 |
253 | 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 |
24E | 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 |
254 | 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 |
24D | Printing.Margins | Gets or sets the page margins to use when printing the VI in inches or centimeters.
This property is similar to the Use custom page margins checkbox on the Print Options page of the VI Properties dialog box and the Custom margins option on the Page Setup page of the Print dialog box. Elements
|
R/W | X |
24B | 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 Print header (name, date, page number) checkbox on the Print Options page of the VI Properties dialog box and the Print header (name, date, page number) checkbox on the Page Setup page of the Print dialog box. |
R/W | X |
24A | Printing.Orientation | Gets or sets the page orientation to use when printing the VI. | R/W | X |
255 | Purgative | R/W | X | |
244 | 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 |
2C2 | SavedVersion | R | X | |
28A | SC.IsSubPanelEditable | R/W | X | |
289 | SC.SuppressParse | R/W | ||
26B | SuppressDataMgr | R/W | X | |
263 | SuppInstVIHalo | R/W | X | |
26C | SuppressTransactInfo | R/W | X | |
287 | SuppressTypeProp | R/W | ||
2B1 | TaggedAndNotEdited | R/W | ||
2B0 | 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.
|
R | X |
205 | TB.ShowAbortBut | Indicates whether to display the Abort Execution button on the toolbar while the VI runs.
This property is similar to the Show Abort button option on the Customize Window Appearance dialog box. |
R/W | X |
204 | TB.ShowFreeRunBut | Indicates whether to display the Run Continuously button on the toolbar while the VI runs.
This property is similar to the Show Run Continuously button option on the Customize Window Appearance dialog box. |
R/W | X |
203 | TB.ShowRunBut | Indicates whether to display the Run button on the toolbar while the VI runs.
This property is similar to the Show Run button option on the Customize Window Appearance dialog box. |
R/W | X |
202 | TB.Visible | Indicates whether to display the toolbar while the VI runs.
This property is similar to the Show toolbar when running option on the Customize Window Appearance dialog box. |
R/W | X |
23A | ToolKitAttr | R/W | ||
285 | CloneName | Name of the clone of a reentrant VI. Returns an error if the VI is not a clone. | R | X |
282 | CompileTime | R | ||
1F6 | 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 VI Description 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 |
257 | VILinkerErr | R | X | |
1F4 | 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.
Note 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 |
1F5 | Path | Path to the VI file.
This property is similar to the Location option on the General page of the VI Properties dialog box. |
R | X |
232 | VIType | Indicates the type of VI. | R | X |
Methods
Show/Hide VI Methods Table
Legend | |
---|---|
RTE | Available in the Run-Time Engine |
Basic Development Environment | |
VI Scripting | |
Private | |
Deprecated |
Method ID | Short Name (English) | Description | RTE |
---|---|---|---|
3EC | 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 Abort Execution button on the toolbar. |
X |
43C | 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. | |
43B | Adapt Nodes Private | ||
44E | AddASPending | ||
4A5 | Try Set Disconnect From Callers Needed | ||
462 | SuppressBackup (Not Implemented) | X | |
463 | UnsuppressBackup (Not Implemented) | X | |
45E | BeginScript (Not Implemented) | X | |
474 | 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 Edit»Clean Up Diagram to clean up the block diagram.
This method is available only in edit mode. |
X |
42C | 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 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.
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. |
|
478 | BD.OpenInNativeWind | X | |
410 | BD.Remove Bad Wires | Removes all the broken wires on the block diagram of the VI.
This method is similar to selecting Edit»Remove Broken Wires. |
|
439 | BD.Set Mod | ||
437 | Cause Type Propagation | X | |
49F | Check AppBuilder Cache | ||
419 | Clear History | Clears the revision history of the referenced VI.
This method is similar to the Reset button on the History window. |
|
4AE | ClearTypeCastLinkRefs | ||
46E | CodeCov.Percentage | ||
46D | CodeCov.Reset | ||
46F | CodeCov.UnrunDiags | ||
493 | CompileToDFIRCPP | ||
491 | CompileToDFIRXML (Not Implemented) | X | |
466 | Compile | Compiles the VI and optionally the entire VI hierarchy of that VI.
Note 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 options input to the Open VI Reference function when you opened the VI reference. |
X |
4B0 | Configure Panel As Hidden | ||
4AD | ContainsLinkRef | ||
457 | CtlVIApplyChanges | X | |
41C | 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.
Note 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 |
41D | 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.
Note 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 |
46B | Ctrl Val.Get Array Element Default | X | |
46A | Ctrl Val.Get Default | X | |
470 | Ctrl Val.Get Type | X | |
41B | 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.
Note 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 |
4A1 | Ctrl Val.Set Multiple | X | |
485 | Copy VI Hierarchy FPGA | ||
49D | 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 Style 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. |
|
443 | Create from Reference | Creates a constant or control using a constant or control reference as a template. | |
484 | 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 Step Into button. | X |
481 | 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 Step Into button on the block diagram toolbar. |
X |
483 | 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 Step Out button on the block diagram toolbar. |
X |
482 | 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 Step Over button on the block diagram toolbar. |
X |
3F3 | 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 Make Current Values Default item in the Edit menu. |
|
3F4 | Default Vals.Reinit All | Changes the current values of all controls on the front panel to their defaults.
This method is similar to the Reinitialize Values to Default item in the Edit menu. |
X |
468 | DeployVI | X | |
479 | Detect Parallel Loops | Detects parallel loops in the VI. | |
44B | DisconnectFromLibrary | Disconnects a VI that a LabVIEW project library owns from the owning project library. | |
414 | Disconnect Polys And Typedefs | ||
401 | Empty | Empties the front panel and block diagram of the VI. | |
45F | EndScript (Not Implemented) | X | |
43F | Enter Text | X | |
4A4 | Export Interface | X | |
411 | Fake Exec State | X | |
464 | 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 |
441 | FP.Center | Specifies whether to automatically center the front panel window on the computer screen.
This method is similar to the Centered option of the Position pull-down menu on the Window Run-Time Position page of the VI Properties dialog box. |
X |
425 | FP.Close | Closes the front panel window.
Use the Front Panel:Open method to open a front panel window. Example |
X |
423 | 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 |
426 | 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 |
438 | 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 |
477 | FP.OpenInNativeWind | X | |
447 | 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 Centered from the Position pull-down menu on the Window Run-Time Position page of the VI Properties dialog box. |
X |
44A | 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 Custom from the Position pull-down menu on the Window Run-Time Position page of the VI Properties dialog box. |
X |
445 | FP.Run-Time Pos.Get | Returns the default position of the front panel window at run-time. | X |
448 | 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 Maximized from the Position pull-down menu on the Window Run-Time Position page of the VI Properties dialog box. |
X |
449 | 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 Minimized from the Position pull-down menu on the Window Run-Time Position page of the VI Properties dialog box. |
X |
446 | 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 Unchanged from the Position pull-down menu on the Window Run-Time Position page of the VI Properties dialog box. |
X |
434 | FP.Set Close If Lonely | X | |
43A | FP.Set Mod | ||
440 | Gen C Code Variant | X | |
412 | Generate VHDL | ||
4AA | Get AppBuilder Source Checksum | ||
49E | GetCallPathsToOtherVI | X | |
495 | GetCompileMetrics | Returns a string that describes transform metrics from the most recent compile of the VI, if metric recording was enabled. | X |
42D | 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 image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs. |
X |
4A7 | 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 |
452 | Get Errors | X | |
49B | 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. | |
461 | GetMenuItemState (Not Implemented) | X | |
4AC | GetMissingDependenciesInfo | X | |
46C | GetNamedInstanceVI | X | |
4A9 | GetObjRefFromBkmrkID | Returns a reference to the object, such as the label, that contains the bookmark. | X |
4AF | GetUDClassLinkRefs | ||
4A8 | 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 |
47A | 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 Static VI Refs? and Include Control VIs? 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 |
4B1 | GetAllHierarchyRefers | X | |
4A6 | GetXMLDataTypes | X | |
454 | GiveTemporaryUnsavedName | ||
4AB | InternalStats | X | |
45D | InvokeBuiltinMenuItem (Not Implemented) | X | |
469 | LadderVIClearLadderEditor | X | |
47F | Get Next VI | X | |
47E | Get Previous VI | X | |
49C | HasLibrary? | X | |
494 | License.Get License Status | X | |
3FD | Lock State.Get | Returns the lock state of the VI and indicates whether the password for the VI is in the password cache. | X |
3FE | Lock State.Set | Sets the lock state of a VI. If interactive is FALSE (default), you can use password to either unlock a password-protected VI or set the password of an unprotected VI. If interactive is TRUE, LabVIEW ignores password and displays a dialog box that prompts you to change the lock state.
This method is similar to the Unlocked (no password), Locked (no password), and Password-protected options on the Protection page of the VI Properties dialog box. |
|
460 | MoveObjects | Moves the objects by the offset amount of pixels. | |
480 | PauseVI | Pauses or unpauses the VI execution. | |
4A2 | 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 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.
Use this method to ensure deterministic execution of asynchronous VI calls. Set the Minimum Size 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 |
415 | Print.Panel To PostScript | Prints the panel of the VI to the specified PostScript file. | X |
3FB | 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 |
3EE | 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 HTML file option on the Destination page of the Print dialog box. |
|
3ED | 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 Printer option on the Destination page of the Print dialog box. |
X |
3EF | Print.VI To RTF | Saves the VI information to an RTF file.
This method is similar to the Rich Text Format (RTF) file option on the Destination page of the Print dialog box. |
|
3F0 | 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 Plain text file option on the Destination page of the Print dialog box. |
|
473 | RefreshErrWinEntry | X | |
430 | 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 |
431 | RP.Close Connection To Client | Closes a remote front panel connection to a client.
This method can return networking error codes. Example |
X |
42E | 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 Regain Control and Lock Control shortcut menu items on the front panel of a running VI. Example |
X |
42F | 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 |
44F | RemoveBreakpoints | X | |
44D | Replicate Conpane | Make the connector pane of the VI Reference match the given connector pane. | X |
492 | ResetGencodeProfileResults | ||
3FA | Revert VI | Discards changes and reloads a VI from disk.
This method is similar to the Revert item on the File menu. |
|
3EB | 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.
Note 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 type specifier VI Refnum 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 options parameter to 0x08 in the Open VI Reference function to prepare the VI for reentrant run. |
X |
467 | Run VI And Deploy | X | |
45A | Save.CopyAsSystem | X | |
400 | 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 LabVIEW Version option on the Save for Previous Version dialog box. |
|
3EA | 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 Save item on the File menu. Note If you use this method to save a VI that is currently running, LabVIEW returns error 1507. |
|
451 | Save.Instrument(NoSync) | ||
3FF | Private Save Instrument | ||
45C | Save.Instrument and Callers Debug | ||
471 | SaveAsInteractive | ||
488 | PrepareForCompileAndSave | ||
413 | Save.Run-Time Menu | Saves the run-time menu to a file specified by Path. This method works only when the VI is running. It saves only menu items with valid tags. | |
41F | Save.Target Instrument | ||
4A0 | Save.Target Instrument For AppBuilder | ||
41A | Save.To Buffer | X | |
47D | Save.VIHierarchyToFolder | ||
459 | Set Filename | X | |
472 | Set Is Instance | ||
496 | Set Is Instance No Owner Check | ||
455 | SetOnlineEdit | X | |
458 | Set Path | ||
465 | SetVIMod | ||
47B | StatechartInstantiateVI | ||
43E | Synch In All Contexts | X | |
453 | Tag.Get Tag Names | X | |
40E | Tag.Get Tag | X | |
40C | Tag.Remove All Tags | X | |
40F | Tag.Remove Tag | X | |
409 | Tag.Remove Tags | X | |
40B | Tag.Set Persistence | X | |
40D | Tag.Set Tag | X | |
40A | Tag.Set Tags | X | |
402 | Transaction.Begin Undo | Begins an undo transaction on a VI. | |
403 | Transaction.End Undo | Ends an undo transaction on a VI. | |
42A | Transaction.Fail | Fails the current transaction and deletes the undo information for the transaction. | |
490 | Get Redo State | Returns whether there is an action to redo and, if so, the text that corresponds to that action. | X |
489 | Get Undo State | Returns whether there is an action to undo and, if so, the text that corresponds to that action. | X |
429 | Transaction.Redo | Redoes the last operation. This is similar to selecting Edit»Redo. | |
428 | Transaction.Undo | Undoes the last operation. This method is similar to selecting Edit»Undo. | |
47C | TransferVICleanupProc | X | |
432 | User Edits.Allow | X | |
433 | User Edits.Block | X | |
427 | VI Hier.Get Signature | X | |
435 | VI Hier.Get User GUID | X | |
486 | Remove Generics From VI Hierarchy | ||
421 | 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 image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs. |
X |
4A3 | LoadVIIconManually | ||
418 | 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. |
|
407 | VI Icon.Set from File | Sets 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.
You also can use the VI Icon:Set from Image Data method to set a VI icon from image data you specify. |
|
422 | VI Icon.Set from Image Data | Sets 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.
If you want to use a pixmap to set the icon, use the Flatten Pixmap VI to convert the data to an image data 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 image data 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. |
|
3E8 | 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 Advanced»Export Strings item on the Tools menu. |
|
42B | VI Strings.Export Private | ||
3E9 | 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 Advanced»Import Strings item on the Tools menu. |
X |
Events
Show/Hide VI EventsTable
Legend | |
---|---|
Basic Development Environment | |
VI Scripting | |
Private | |
Deprecated |
Code | Name | Type |
---|---|---|
1073741887 | BD Selection Change | Filter |
1073741895 | DiagNodeSize | Notify |
1073741847 | Key Down | Notify |
2147483658 | Key Down? | Filter |
1073741848 | Key Repeat | Notify |
2147483659 | Key Repeat? | Filter |
1073741836 | Key Up | Notify |
2147483680 | Menu Activation?) | Filter |
1073741851 | Menu Selection (App) | Notify |
1073741829 | Menu Selection (User) | Notify |
2147483654 | Menu Selection? (App) | Filter |
1073741839 | Mouse Enter | Notify |
1073741838 | Mouse Leave | Notify |
1073741849 | Panel Close | Notify |
2147483651 | Panel Close? | Filter |
1073741843 | Panel Resize | Notify |
1073741894 | Start Diagram Drag | Notify |
1073741860 | VI Will Be Purged | Notify |
History
![]() |
History information is needed. What changes have occurred over previous versions? |
Version | Change(s) |
---|---|
![]() |
More info to come. |