How to do Menu Launch VIs - Revision history

MichaelAivaliotis: Added an example screenshot and more information on getting the calling VI path and name.

2025-02-15T01:59:11Z

Added an example screenshot and more information on getting the calling VI path and name.

← Older revision		Revision as of 01:59, 15 February 2025
Line 5:		Line 5:
	==Menu Launch Folders==		==Menu Launch Folders==

	* .\wizard - File menu-launch		* .\wizard - '''File''' menu-launch
	* .\project - Tools menu-launch		* .\project - '''Tools''' menu-launch
	* .\help - Help menu-launch		* .\help - '''Help''' menu-launch


Line 18:		Line 18:
	Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.		Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.

	Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need".		Text File Guidelines:

			* The text file must have the same name as its containing folder.
			* Folders and VIs should be listed by filename in the desired order in the text file.
			* Separators can be denoted by a dash (“-”).
			* Each entry - whether a VI, folder, or separator – must occupy its own line in the text file.

			Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need". Any items that are not listed in the text file will be added after the text file's contents.

			== Example ==
			The following image is an example of a custom menu item, “Custom Menu” created in LabVIEW. Notice that “Custom Menu” contains two items and one sub-menu. The folder structure is also shown. Notice that this folder is located in ''labview''\project and contains two VIs and one sub-folder. The VIs are displayed in the menu as items, and the sub-folder is displayed as a sub-menu.
			[[File:Filefolderscreenshot.png\|center\|frame\|LabVIEW tools menu file layout example.]]
			[[File:ToolsMenuScreenshot.png\|center\|frame\|Custom LabVIEW Tools menu example.]]

	==Autorun==		==Autorun==
Line 26:		Line 38:
	The .\wizard (Files) VIs don't show up in Project windows.		The .\wizard (Files) VIs don't show up in Project windows.

	==Get calling VI==		== Get calling VI ==
	~~{\|class="wikitable" style="margin: 1em auto 1em auto" border="1" cellpadding="0" cellspacing="0"~~		It many situations, it is useful for a menu item to obtain information about the VI that was open when the menu was selected. Menu Launch VI Information.vi (available since LabVIEW 2009) returns the Application reference and VI Name for the VI which was active when this menu item was launched. It is available in labview\vi.lib\VIServer
	\|+		[[File:Menu Launch VI Information.png\|center\|frame\|Example of using the Menu Launch VI Information.vi]]
	~~! Private Feature Exposed~~
	\|-
	~~\| There~~ is a ~~private~~ VI ~~server method called Application:~~Menu Launch VI ~~may be found exposed on the diagram of the "Web Publishing Tool" (.\project\webdoc.llb\_Web Document Tool~~.vi) ~~this property~~ returns the ~~last VI to call a "Tools" menu~~ VI ~~(it doesn't work~~ for ~~"Help" menu), but returns it only once then returns a null string until another "Tools" menu~~ VI ~~is selected from the~~ menu~~. Use this feature to create a tool that operates on the VI that the user~~ launched ~~it from, like "Check into Source Code Control", or something similar. Unfortunately this does not work for the File (~~.\~~wizard) or Help (~~.\~~help) menus.~~
	\|}
	~~<!-- --~~[[~~User~~:~~Pjm labview~~\|~~Pjm_labview~~]] ~~23:38, 16 March 2007 (CDT) -->~~

	[[Category:Development Environment]]		[[Category:Development Environment]]

Q: Undo rollback. Didn’t mean to do it.

2024-08-10T06:28:13Z

Undo rollback. Didn’t mean to do it.

← Older revision		Revision as of 06:28, 10 August 2024
Line 35:		Line 35:
	<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->		<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->

	[[Category:~~IDE Add-ons~~]]		[[Category:Development Environment]]

Q: Reverted edits by Logmanoriginal (talk) to last revision by Q

2024-08-10T06:26:27Z

Reverted edits by Logmanoriginal (talk) to last revision by Q

← Older revision		Revision as of 06:26, 10 August 2024
Line 35:		Line 35:
	<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->		<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->

	[[Category:~~Development Environment~~]]		[[Category:IDE Add-ons]]

Logmanoriginal: Move to :Category:Development Environment

2024-08-09T06:42:43Z

Move to Category:Development Environment

← Older revision		Revision as of 06:42, 9 August 2024
Line 35:		Line 35:
	<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->		<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->

	[[Category:~~IDE Add-ons~~]]		[[Category:Development Environment]]

Q: Category reorg

2020-05-08T20:15:48Z

Category reorg

← Older revision		Revision as of 20:15, 8 May 2020
Line 35:		Line 35:
	<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->		<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->

	[[Category:~~Development Environment~~]]		[[Category:IDE Add-ons]]

Logmanoriginal: Fix category assignment

2020-04-10T10:02:13Z

Fix category assignment

← Older revision		Revision as of 10:02, 10 April 2020
Line 35:		Line 35:
	<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->		<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->

	[[Category:Development ~~environment~~]]		[[Category:Development Environment]]

Tcplomp at 19:09, 18 October 2012

2012-10-18T19:09:51Z

← Older revision		Revision as of 19:09, 18 October 2012
Line 1:		Line 1:
			==Customizing LabVIEW Menus==

	LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.		LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.

	~~[u]~~Menu Launch Folders~~:[/u]~~		==Menu Launch Folders==

	* .\wizard - File menu-launch		* .\wizard - File menu-launch

Tcplomp: /* Notes */

2012-10-18T19:06:25Z

Notes

← Older revision		Revision as of 19:06, 18 October 2012
Line 22:		Line 22:

	==Notes==		==Notes==
	The /wizard (Files) VIs don't show up in Project windows.		The .\wizard (Files) VIs don't show up in Project windows.

	==Get calling VI==		==Get calling VI==

Tcplomp at 19:06, 18 October 2012

2012-10-18T19:06:01Z

← Older revision		Revision as of 19:06, 18 October 2012
Line 5:		Line 5:
	* .\wizard - File menu-launch		* .\wizard - File menu-launch
	* .\project - Tools menu-launch		* .\project - Tools menu-launch
	* .\help - Help menu-launch		* .\help - Help menu-launch


	The .\wizard, .\project, and .\help folders are intrinsically related to the "File", "Tools", and "Help" menus, respectively. When you install a LabVIEW add-on, you will notice that new menu items are usually added to these two menus. This was achieved by adding files to the .\project and .\help folders. Through a little experimentation the nature of this process has been determined to be the following:		The .\wizard, .\project, and .\help folders are intrinsically related to the "File", "Tools", and "Help" menus, respectively. When you install a LabVIEW add-on, you will notice that new menu items are usually added to these two menus. This was achieved by adding files to the .\project and .\help folders. Through a little experimentation the nature of this process has been determined to be the following:

			==Technical details==
	First, LabVIEW looks in the .\wizard, .\project, and .\help folders for standalone VIs and top-level VIs within LLBs. In the .\help folder, it also looks for .hlp and .chm compiled help files. These files are then opened when selected from the menu. LabVIEW will look recursively through all subfolders and LLBs looking for these files of interest. However, the search will ignore any VIs, folders, or LLBs whose name begins with an underscore ("_") character. When the search finds a file of interest it will create a menu item at a location, which reflects where it found it in the directory structure inside the project or help folder. For Example, if it finds the file .\project\Goop Tools\Rename Goop Class.vi, it will create the menu item Tools/GOOP Tools/Rename GOOP Class.		First, LabVIEW looks in the .\wizard, .\project, and .\help folders for standalone VIs and top-level VIs within LLBs. In the .\help folder, it also looks for .hlp and .chm compiled help files. These files are then opened when selected from the menu. LabVIEW will look recursively through all subfolders and LLBs looking for these files of interest. However, the search will ignore any VIs, folders, or LLBs whose name begins with an underscore ("_") character. When the search finds a file of interest it will create a menu item at a location, which reflects where it found it in the directory structure inside the project or help folder. For Example, if it finds the file .\project\Goop Tools\Rename Goop Class.vi, it will create the menu item Tools/GOOP Tools/Rename GOOP Class.

			==Menu Naming method==
	Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.		Here is where a twist is thrown into the naming rules. You can override the names of the VIs, .chm and .hlp files, folders and LLBs so that they are named differently in the menu structure from their names on disk. For VIs, LabVIEW will use the "Window Title" as the menu name (this is also the VI Server VI:Front Panel Window:Title property). But, by placing a text file with the identical root name (RootName.vi, RootName.txt) in the same location as the folder or file, you can specify the name LabVIEW should use in the menus. The name you wish to use in the menu should be placed in the text file. For example, if you have a VI called MyBuggyCode.vi, you can make the menu item show up as Elegant Solution by creating a text file called MyBuggyCode.txt that contains the contents "Elegant Solution" and placing it in the same directory as MyBuggyCode.vi.

	Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need".		Note that this override method works for LLBs, folders, .hlp, and .chm files, but for .hlp and .chm files you must also add the characters ".hlp" or ".chm" after the menu item name in the overriding text file. The file MyCHM.chm should have an override text file called MyCHM.txt that contains the contents "All The Help You Need.chm" This will cause its menu name to be "All The Help You Need".

			==Autorun==
	How does the developer use this feature, whereby they can open VIs and help files from the menu? VIs placed in the Tools menu (.\project folder) should always be set to "Run When Opened". This will cause them to look and feel like a functional dialog or tool once they are opened after being selected from the menu.		How does the developer use this feature, whereby they can open VIs and help files from the menu? VIs placed in the Tools menu (.\project folder) should always be set to "Run When Opened". This will cause them to look and feel like a functional dialog or tool once they are opened after being selected from the menu.

			==Notes==
			The /wizard (Files) VIs don't show up in Project windows.

			==Get calling VI==
	{\|class="wikitable" style="margin: 1em auto 1em auto" border="1" cellpadding="0" cellspacing="0"		{\|class="wikitable" style="margin: 1em auto 1em auto" border="1" cellpadding="0" cellspacing="0"
	\|+		\|+
	! Private Feature Exposed		! Private Feature Exposed
	\|-		\|-
	\| There is a private VI server method called Application:Menu Launch VI may be found exposed on the diagram of the "Web Publishing Tool" (.\project\webdoc.llb\_Web Document Tool.vi) this property returns the last VI to call a "Tools" menu VI (it doesn't work for "Help" menu), but returns it only once then returns a null string until another "Tools" menu VI is selected from the menu. Use this feature to create a tool that operates on the VI that the user launched it from, like "Check into Source Code Control", or something similar. Unfortunately this does not work for the File (.\wizard) or Help (.\help) menus.		\| There is a private VI server method called Application:Menu Launch VI may be found exposed on the diagram of the "Web Publishing Tool" (.\project\webdoc.llb\_Web Document Tool.vi) this property returns the last VI to call a "Tools" menu VI (it doesn't work for "Help" menu), but returns it only once then returns a null string until another "Tools" menu VI is selected from the menu. Use this feature to create a tool that operates on the VI that the user launched it from, like "Check into Source Code Control", or something similar. Unfortunately this does not work for the File (.\wizard) or Help (.\help) menus.
	\|}		\|}
	<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->		<!-- --[[User:Pjm labview\|Pjm_labview]] 23:38, 16 March 2007 (CDT) -->

	[[~~category~~:~~development~~ environment]]		[[Category:Development environment]]

Michael_Aivaliotis at 08:03, 3 February 2009

2009-02-03T08:03:57Z

← Older revision		Revision as of 08:03, 3 February 2009
Line 1:		Line 1:
	~~== LabVIEW Documentation: Menu Launch VIs ==~~

	LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.		LabVIEW provides a mechanism, which allows the user to open VIs and help files by selecting them from the Tools and Help pull-down menus. This is a very powerful feature for development tools creation, so I will describe how this works. When LabVIEW starts up it does several things, which include initializing the menus. This is a process where LabVIEW looks for files within specific directories for inclusion in the menus.