Project class
| <VI Server Class Hierarchy |
 |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
The Project class is a class in the VI Server Class Hierarchy, (see also VI Server).
| Legend | |
|---|---|
| R/W | Readable/Writable {R = Read Only, W = Write Only, R/W = Read/Write} |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
Properties
Show/Hide Application Properties Table
| Property ID | Short Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 27109408 | ActiveItemsInTree | If the Project Explorer window has focus, returns an array of references to the selected project items in the Project Explorer window. If the Project Explorer window does not have focus, returns a reference to the project item associated with the VI window that has focus. You can use these references with the ProjectItem properties.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R | |
| 2710940D | App | Returns the application reference for the My Computer target in the LabVIEW project. You can use this reference with the Application properties.
If the project has multiple targets, each target is associated with a single application instance. Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R | X |
| 2710940B | DebugGetQueuedCalls | R | X | |
| 2710940A | DebugTestPropVI | W | X | |
| 2710940E | Description | Gets or sets the description of the LabVIEW project. You also can use the Project page of the Project Properties dialog box to set the project description.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R/W | X |
| 2710940C | DiscoverableDeviceTypes() | R/W | ||
| 27109427 | Files View Root | R | X | |
| 27109414 | InstallerFilePaths() | R | ||
| 2710941F | IsDefaultProject | R | ||
| 27109425 | Items View Active | Show or hide the Items page in the Project Explorer window. | R/W | |
| 27109424 | LastFoundItem | R/W | X | |
| 27109423 | Loaded Version | R | ||
| 2710940F | Locked | R/W | ||
| 27109421 | MyComputer | Returns a reference to My Computer in the Project Explorer window for the LabVIEW project. You can use this reference with the TargetItem properties.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R | X |
| 27109401 | Name | Gets the name of the LabVIEW project. If the project has been saved, this property returns the filename with the file extension. If the project has not been saved, this property returns untitled project x and you can write to this property to change the name.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R/W | X |
| 27109410 | OperationIsInteractive | R | ||
| 27109402 | Path | Gets the path to the saved LabVIEW project on disk. This path includes the filename of the project.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R | X |
| 27109411 | Providers() | R | ||
| 27109426 | Resolve Conflicts.Visible | R/W | X | |
| 27109403 | Root | Returns a reference to the project root in the Project Explorer window. The project root is the top item that represents the LabVIEW project in the Project Explorer window. You can use this reference with the ProjectItem properties.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. Example |
R | X |
| 27109422 | SelectedItemsInTree | Returns an array of references to the project items currently selected in the Project Explorer window. You can use these references with the ProjectItem properties.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R | |
| 27109428 | SeparateCompCodeForNewProjectItems | R/W | ||
| 27109420 | Targets | Returns an array of references to all targets in the current LabVIEW project. You can use these references with the TargetItem properties.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R | X |
| 27109409 | WindowState | Returns the state of the Project Explorer window.
Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. |
R |
Methods
Show/Hide Application Methods Table
| Method ID | Short Name (English) | Description | RTE |
|---|---|---|---|
| 2710904C | AutoDiscoverCallOverride | X | |
| 2710904B | AutoDiscoverOverrideType | X | |
| 2710904A | AutoDiscoverSupportsType | X | |
| 27109045 | BeginIOScanTimeCollection | ||
| 27109049 | Bounds | X | |
| 27109051 | BrowseVariableDialog | Displays a dialog box that allows you to browse for a variable and then returns a reference to the variable you select. | |
| 27109038 | BuildAssembliesFromProject | ||
| 2710903B | BuildAssembliesToProject | ||
| 27109039 | ChangeCEMode | X | |
| 27109002 | Close | Closes a LabVIEW project and all references to all items in the project. This method also closes the Project Explorer window if it is open and closes any VIs that are open in any application instance owned by the project. You also can select File»Close All to close the project and the Project Explorer window.
Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. |
X |
| 2710900A | Close Window | Closes only the Project Explorer window. This method does not close VI windows.
You also can select File»Exit to close the Project Explorer window and any VIs that are open. Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. |
|
| 27109012 | Copy From Project | ||
| 27109013 | Copy To Project | ||
| 2710900D | Create Context For Instance | ||
| 27109048 | Create Context For Instance Without Sublib Loading | ||
| 2710900C | Create Context For Type | ||
| 27109015 | Deploy Items | Deploys an array of items in the LabVIEW project.
In the Project Explorer window, you also can open and run a VI under a target to deploy files to the target. Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. |
|
| 27109014 | Do Interactive Save | ||
| 2710903D | DoQueuedNotifications | X | |
| 27109046 | EndIOScanCollection | ||
| 27109042 | Files View.Get Contents | X | |
| 2710901F | Get Bld Tokens | ||
| 27109050 | Get Deployable Deps | ||
| 2710903A | GetItemsFromSourceID | X | |
| 2710901B | Proj Item From Ref | ||
| 2710904E | GetFilesViewItem | X | |
| 27109047 | GetIOScanTime | ||
| 27109022 | Has Behaviors | ||
| 27109037 | IndustrialDeployItems | X | |
| 27109043 | IndustrialUndeployAll | X | |
| 27109044 | IndustrialUndeployItems | X | |
| 27109052 | IsItemIDUnderDependencies | X | |
| 27109006 | Item From Item ID | ||
| 27109031 | Delete Item | Deletes an item from the local project settings file. | |
| 27109032 | Delete Section | Deletes an entire section from the local project settings file. | |
| 2710902F | Get Item | Gets an item from the local project settings file. | X |
| 27109033 | Has Item | Determines if an item exists in the local project settings file. | X |
| 27109034 | Has Section | Determines if a section exists in the local project settings file. | X |
| 27109030 | Set Item | Sets an item in the local project settings file. | |
| 27109029 | MoveFiles | X | |
| 2710902C | MoveFilesDialogs | X | |
| 2710902D | MoveFolderContents | X | |
| 2710902E | MoveFolderContentsDialog | X | |
| 27109021 | Open Application | X | |
| 27109009 | Open Window | Displays the Project Explorer window.
You also can select File»Open Project to display the Project Explorer window. Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. Example |
|
| 27109023 | Populate Provider Tree | ||
| 2710904D | Populate Provider Tree Files View | ||
| 27109025 | PostNoClose | ||
| 2710901C | PreviewDataFiles | ||
| 27109020 | Query Type Behavior | ||
| 2710903E | Refresh Auto-Populating Folders | Force all auto-populated folders on this project to update their contents to match the disk. | X |
| 2710902A | RenameFiles | X | |
| 2710902B | RenameFilesDialogs | X | |
| 27109040 | Resolve Conflicts.AutomateDlg | X | |
| 2710903F | Resolve Conflicts.Get Contents | X | |
| 27109041 | Resolve Conflicts.UseSelectedItem | X | |
| 27109003 | Save | Saves the LabVIEW project to the path that the project was previously saved to or loaded from or to a specified path.
If the project has not been saved and the value of the Path parameter is or Path is unwired, this method returns an error. You also can select File»Save Project to save the project. Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. |
|
| 27109026 | Save As | Allows a LabVIEW project to be saved as a different name or to a different location. This method also enables the save operation to copy all of the contents of the project to the new location. If you do not wire data to Items to copy, LabVIEW copies everything to the new location. Otherwise, LabVIEW copies only the items you specify. | |
| 27109036 | Save As Test | X | |
| 27109053 | Save As With Rename | ||
| 27109055 | Save As With Rename Prog Close | ||
| 27109054 | Save As With Rename Prog Inc | ||
| 27109027 | SaveCopy | Saves a copy of the project to a new location on disk, where all referenced VIs are in the same location.
Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. |
|
| 27109024 | Save For Previous | Saves a copy of the LabVIEW project that is readable by LabVIEW 8.0 and later. This method is similar to the LabVIEW Version selection in the Save for Previous Version dialog box.
Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. |
|
| 27109028 | Save Items for SCC | ||
| 2710901A | Save Specified Dirty Items | ||
| 2710903C | Set DocMod | ||
| 27109016 | Start Items | ||
| 27109017 | Stop Items | ||
| 27109035 | SuppressChangeNotifications | X | |
| 27109018 | Undeploy Items | Undeploys an array of items and their dependencies. | |
| 2710904F | UpdateFilesViewData | X | |
| 2710901E | Write Data Files |
Events
No Events for this Class
History
 |
History information is needed. What changes have occured over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |