Project Explorer - Revision history

Q: /* See Also */

2024-03-21T14:43:54Z

Q: /* Project Providers */

2024-03-21T14:42:01Z

Project Providers

← Older revision		Revision as of 14:42, 21 March 2024
Line 159:		Line 159:

	== Project Providers ==		== Project Providers ==
	Project Providers are the way to add functionality to the Project Explorer. They allow additions to the Toolbar and Right-click menus, ~~allow~~ the creation of special [[ProjectItem]] types, ~~creation of~~ additional dialogs and ~~wizard~~, and ~~creation of addition~~ overlays. To learn more see [[Project Provider]]s.		Project Providers are the way to add functionality to the Project Explorer. They allow additions to the Toolbar and Right-click menus, the creation of special [[ProjectItem]] types, additional dialogs and wizards, and additional overlays. To learn more see [[Project Provider Framework]].

	== History ==		== History ==

Q: /* Targets */

2020-06-09T16:31:58Z

Targets

← Older revision		Revision as of 16:31, 9 June 2020
Line 58:		Line 58:

	=== Targets ===		=== Targets ===
	There are many types of targets (i.e. Real-time OSs, [[FPGA]]s, [[cRIO]]s, [[Raspberry Pi]], etc. Code cannot be shared across targets. Trying to use a [[LabVIEW Class]] by two targets will cause the class to be locked for editing.		There are many types of targets (i.e. Real-time OSs, [[FPGA]]s, [[cRIO]]s, [[Raspberry Pi]], etc. Code cannot be shared easily across targets. Trying to use a [[LabVIEW Class]] by two targets will cause the class to be locked for editing.

	=== Overlays ===		=== Overlays ===

Q: /* See Also */ typo

2020-06-08T21:32:47Z

Q: /* Toolbars */ formatting

2020-06-08T21:26:02Z

Toolbars: formatting

← Older revision		Revision as of 21:26, 8 June 2020
Line 76:		Line 76:
	! Description		! Description
	\|-		\|-
	\| colspan=2 \| '''Standard Toolbar'''		! colspan=2 style="text-align: left;" \| '''Standard Toolbar'''
	\|-		\|-
	\| [[File:Project Explorer-New.png\|center\|frameless]]		\| [[File:Project Explorer-New.png\|center\|frameless]]
Line 99:		Line 99:
	\| Remove from Project - Deletes item from the project. All child items, if a folder or library, are also removed from the project.		\| Remove from Project - Deletes item from the project. All child items, if a folder or library, are also removed from the project.
	\|-		\|-
	\| colspan=2 \| '''Project Toolbar'''		! colspan=2 style="text-align: left;" \| '''Project Toolbar'''
	\|-		\|-
	\| [[File:Project Explorer-Open Project.png\|center\|frameless]]		\| [[File:Project Explorer-Open Project.png\|center\|frameless]]
Line 113:		Line 113:
	\| Resolve Conflicts... - opens conflict resolution dialog.		\| Resolve Conflicts... - opens conflict resolution dialog.
	\|-		\|-
	\| colspan=2 \| '''Build Toolbar'''		! colspan=2 style="text-align: left;" \| '''Build Toolbar'''
	\|-		\|-
	\| [[File:Project Explorer-Build All.png\|center\|frameless]]		\| [[File:Project Explorer-Build All.png\|center\|frameless]]
Line 124:		Line 124:
	\| Run From Build - builds and then the selected item in '''Build Specification'''		\| Run From Build - builds and then the selected item in '''Build Specification'''
	\|-		\|-
	\| colspan=2 \| '''Source Control Toolbar'''		! colspan=2 style="text-align: left;" \| '''Source Control Toolbar'''
	\|-		\|-
	\| [[File:Project Explorer-Check Out.png\|center\|frameless]]		\| [[File:Project Explorer-Check Out.png\|center\|frameless]]
Line 145:		Line 145:
	! Description		! Description
	\|-		\|-
	\| colspan=2 \| '''Unit Test Framework Toolbar'''		! colspan=2 style="text-align: left;" \| '''Unit Test Framework Toolbar'''
	\|-		\|-
	\| [[File:Project Explorer-Run Unit Test.png\|center\|frameless]]		\| [[File:Project Explorer-Run Unit Test.png\|center\|frameless]]

Q: Finished page

2020-06-08T21:22:34Z

Finished page

Show changes

Q at 17:30, 8 June 2020

2020-06-08T17:30:16Z

← Older revision		Revision as of 17:30, 8 June 2020
Line 23:		Line 23:
	=== Dependencies ===		=== Dependencies ===

	Dependencies are files used by files inside the [[LabVIEW Project#Code\|code]] section and not explicitly added to the project. LabVIEW~~ ~~8.5 and up have separate categories for [[Vi.lib\|vi.lib]], [[User.lib\|user.lib]] and [[Instr.lib\|instr.lib]].		Dependencies are files used by files inside the [[LabVIEW Project#Code\|code]] section and not explicitly added to the project. [[LabVIEW 8.5]] and up have separate categories for [[Vi.lib\|vi.lib]], [[User.lib\|user.lib]] and [[Instr.lib\|instr.lib]].

	=== Build specifications ===		=== Build specifications ===
Line 35:		Line 35:

	== Project Items ==		== Project Items ==
	Project Items are individual items as they appear in the tree in the Project Explorer. ~~Besides files for VIs,~~ Libraries~~, and~~ Classes~~; there are items for~~ folders, targets, build specifications~~, etc.~~ ~~The~~ [[ProjectItem ~~class/Type String property~~]] can be used to get the value needed for the ''Type'' parameter of the ''[[ProjectItem class/Get All Descendents method]]''. That method allows you to get all children in the Project that match that specific type. A list of valid ''Type String'' values and their descriptions are listed on the [[ProjectItem]] page.		Project Items are individual items as they appear in the tree in the Project Explorer. They can be:
			* [[VI]]s
			* Libraries
			* Classes
			* folders
			* targets
			* build specifications
			* and more

			A list of valid [[ProjectItem]]s types can be found on the [[ProjectItem]] page.

	=== Folders ===		=== Folders ===
			Elements in a project can be organized using folders. The original [[LabVIEW Project]] implementation from [[LabVIEW 8]] to [[LabVIEW 8.20\|8.2]] only allowed for ''Virtual folders'' where there was no connection between the project folder or a disk folder. Upon user request, in [[LabVIEW 8.5]] support was added for [[Auto-populating Folder]]s. These folders are a shortcut to a folder on a disk and will include all the files inside that folder (including sub-folders). However, only [[LabVIEW Project]]s can have [[Auto-populating Folder]]s. Other libraries can only have [[Virtual Folder]]s. '''Note:''' Mixing [[Auto-populating Folder]]s in a [[LabVIEW Project]] with [[Virtual Folder]]s in other libraries is not recommended and might cause [[Cross link\|cross-linking]] issues.

			=== Libraries ===
			Libraries provide organization within a project as folders do. However, unlike folders, libraries provide [[wikipedia:Namespace\|namespacing]] and modularization. In a project [[VI]]s must have unique names to avoid [[Cross link\|cross-linking]] issues. A library allows for VIs with the same name by providing a namespace for them, the library name is prepended to the VI name.

			Also, when libraries are added to a project only the library file is referenced by the project. This means that everything the library owns is known only to the library file and not to the project file. This is helps with modularization because adding to or modifying the library won't necessitate a change to the project file and wouldn't require the project file to be updated in [[Source Code Control]].

			=== Nested Libraries ===
			Some library types allow for nesting libraries (a library inside of a library). [[LabVIEW Project Library\|LabIEW Project Libraries]], [[LabVIEW Class\|LabVIEW Classes]], [[LabVIEW StateChart\|LabVIEW StateChart Libraries]], and [[XControl]]s can be added to other [[LabVIEW Project Library\|LabIEW Project Libraries]] or [[XControl]]s, only the nested library file is referenced in the parent library file, like with projects. Again, this helps with modularization by requiring only the modified library to be updated in [[Source Code Control]] and not the parent library. '''Note:''' [[LabVIEW Class\|LabVIEW Classes]] are not allowed to have nested libraries.

			=== Targets ===
			There are many types of targets (i.e. Real-time OSs, [[FPGA]]s, [[cRIO]]s, [[Raspberry Pi]], etc. Code cannot be shared across targets. Trying to use a [[LabVIEW Class]] by two targets will cause the class to be locked for editing.

			=== Overlays ===

			== Menu Bar ==

	Elements in a project can be organized using folders. The original LabVIEW project implementation from [[LabVIEW 8]] to [[LabVIEW 8.20\|8.2]] only allowed for ''Virtual folders'' where there was no connection between the project folder or a disk folder. Upon user request, in [[LabVIEW 8.5]] support was added for ''Auto-Populating folders''. These folders are a shortcut to a folder on a disk and will include all the files inside that folder (including sub-folders). However, only [[LabVIEW Project]]s can have ''Auto-Populating folders'', [[LabVIEW Project Library\|LabIEW Project Libraries]] and [[LabVIEW Class\|LabVIEW Classes]] can only have ''Virtual folders''. '''Note:''' Mixing Auto-Populating folders in a [[LabVIEW Project]] with Virtual folders in[[LabVIEW Project Library\|LabIEW Project Libraries]] and [[LabVIEW Class\|LabVIEW Classes]] is not recommended and might cause [[Cross link\|cross-linking]] issues.		== Tool Bar ==

	== Tips and tricks ==		== Tips and tricks ==
	* Select '''Arrange By''' from the right-click menu of a folder to choose between different sorting options.		* Select '''Arrange By''' from the right-click menu of a folder to choose between different sorting options.
	* Drop any file into the '''Project Explorer''' to add it to the project. This also works for multiple files and folders.		* Drop any file into the '''Project Explorer''' to add it to the project. This also works for multiple files and folders.

			== Project Providers ==
			Project Providers are the way to add functionality to the Project Explorer. To learn more see [[Project Provider]]s.

	== History ==		== History ==

Q: Moved table to ProjectItems page. Added link to it instead.

2020-06-07T23:05:20Z

Moved table to ProjectItems page. Added link to it instead.

@@ Line 35: / Line 35: @@
 == Project Items ==
-Project Items are individual items as they appear in the tree in the Project Explorer.  Besides files for VIs, Libraries, and Classes; there are items for folders, targets, build specifications, etc. A complete list is shown below:
+Project Items are individual items as they appear in the tree in the Project Explorer.  Besides files for VIs, Libraries, and Classes; there are items for folders, targets, build specifications, etc.  The [[ProjectItem class/Type String property]] can be used to get the value needed for the ''Type'' parameter of the ''[[ProjectItem class/Get All Descendents method]]''.  That method allows you to get all children in the Project that match that specific type.  A list of valid ''Type String'' values and their descriptions are listed on the [[ProjectItem]] page.
 === Folders ===
 Elements in a project can be organized using folders. The original LabVIEW project implementation from [[LabVIEW 8]] to [[LabVIEW 8.20|8.2]] only allowed for ''Virtual folders'' where there was no connection between the project folder or a disk folder.  Upon user request, in [[LabVIEW 8.5]] support was added for ''Auto-Populating folders''. These folders are a shortcut to a folder on a disk and will include all the files inside that folder (including sub-folders). However, only [[LabVIEW Project]]s can have ''Auto-Populating folders'', [[LabVIEW Project Library|LabIEW Project Libraries]] and [[LabVIEW Class|LabVIEW Classes]] can only have ''Virtual folders''. '''Note:''' Mixing Auto-Populating folders in a [[LabVIEW Project]] with Virtual folders in[[LabVIEW Project Library|LabIEW Project Libraries]] and [[LabVIEW Class|LabVIEW Classes]] is not recommended and might cause [[Cross link|cross-linking]] issues.
 == Tips and tricks ==

Q at 19:53, 7 June 2020

2020-06-07T19:53:27Z

← Older revision		Revision as of 19:53, 7 June 2020
Line 9:		Line 9:

	== Items Page ==		== Items Page ==
			The '''Items Page''' shows the contents of a project separated into ''Targets''. Each target represents a platform on which the code will run, for instance, Real-Time modules, FPGA modules, or "My Computer" representing a Windows, Mac, or Linux OS.
	The contents of a project ~~are~~ separated into ''Targets''. Each target represents a platform on which the code will run, for instance, Real-Time modules, FPGA modules, or "My Computer" representing a Windows, Mac, or Linux OS.

	Under each target three subdivisions are made:		Under each target three subdivisions are made:
Line 31:		Line 30:

	These builds can be included in an installer.		These builds can be included in an installer.

			== Files Page ==
			The '''Files Page''' shows the contents of a project by the directory structure on disk. It does not show the entire file system. Instead, it only shows the directory structure of where items in the project or in the dependencies exist on disk. If a mass file move needs to happen, it is better to do it here that using the files system because it allows LabVIEW to update and maintain any file linking.

	== Project Items ==		== Project Items ==
Line 37:		Line 39:
	=== Folders ===		=== Folders ===

	Elements in a project can be organized using folders. (The original LabVIEW project implementation (LabVIEW 8.0-8.2) only allowed ~~so called~~ ''Virtual folders'' where there was no connection between the project folder or a disk folder.) Upon user request LabVIEW 8.5 added ~~support~~ for ''Auto-Populating folders''.~~ ~~These folders are a shortcut to a folder on a disk and will include all the files inside that folder (including sub-folders). ~~Mixing~~ Auto-Populating folders ~~with~~ ''LabVIEW ~~library~~ folders'' is not recommended and might cause [[Cross link\|cross-~~links~~]].~~''''''~~		Elements in a project can be organized using folders. The original LabVIEW project implementation from [[LabVIEW 8]] to [[LabVIEW 8.20\|8.2]] only allowed for ''Virtual folders'' where there was no connection between the project folder or a disk folder. Upon user request, in [[LabVIEW 8.5]] support was added for ''Auto-Populating folders''. These folders are a shortcut to a folder on a disk and will include all the files inside that folder (including sub-folders). However, only [[LabVIEW Project]]s can have ''Auto-Populating folders'', [[LabVIEW Project Library\|LabIEW Project Libraries]] and [[LabVIEW Class\|LabVIEW Classes]] can only have ''Virtual folders''. '''Note:''' Mixing Auto-Populating folders in a [[LabVIEW Project]] with Virtual folders in[[LabVIEW Project Library\|LabIEW Project Libraries]] and [[LabVIEW Class\|LabVIEW Classes]] is not recommended and might cause [[Cross link\|cross-linking]] issues.

	=== GUID Index ===		=== GUID Index ===
Line 113:		Line 115:
	\| {CC472C20-0441-48DC-AF25-3E82ECC9376F}		\| {CC472C20-0441-48DC-AF25-3E82ECC9376F}
	\|}		\|}

	~~== Files Page ==~~


	== Tips and tricks ==		== Tips and tricks ==

Q at 19:28, 7 June 2020

2020-06-07T19:28:51Z

← Older revision		Revision as of 19:28, 7 June 2020
Line 52:		Line 52:
	\| Folder		\| Folder
	\| {D60740D6-F254-4BBC-5675-8858F35B820E}		\| {D60740D6-F254-4BBC-5675-8858F35B820E}
	\|
	\|-		\|-
	\| Auto Populating Folder		\| Auto Populating Folder

← Older revision		Revision as of 14:43, 21 March 2024
Line 181:		Line 181:
	* [[Real-time]]		* [[Real-time]]
	* [[Unit Test Framework]]		* [[Unit Test Framework]]
	* [[Project ~~Providers~~]]		* [[Project Provider Framework]]

	== External Links ==		== External Links ==

← Older revision		Revision as of 21:32, 8 June 2020
Line 176:		Line 176:
	* [[LabVIEW Project]]		* [[LabVIEW Project]]
	* [[LabVIEW Project Library]]		* [[LabVIEW Project Library]]
	* [[~~LabvIEW~~ Class]]		* [[LabVIEW Class]]
	* [[LabVIEW LINX]]		* [[LabVIEW LINX]]
	* [[FPGA]]		* [[FPGA]]