ProjectItem class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	ProjectItem class
Class ID	74
Scope	Basic Development Environment
Class Inheritance	This class is a top-level class.
Class Children	ProjectItem BuildSpecification LVClassPropDefFolder Library LibraryData PropertyFolder TargetItem ProjectItem BuildSpecification LVClassPropDefFolder Library LibraryData PropertyFolder TargetItem

The ProjectItem class is a class in the VI Server Class Hierarchy, (see also VI Server). The ProjectItem class allows you to inspect and modify items that appear in the Project Explorer window, such as VIs, Virtual Folders, classes, libraries, etc.

Properties

Show/Hide ProjectItem Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

ProjectItem Properties Table

Property ID	Long Name (English)	Description	R/W	RTE
35B53C00	Type GUID	Gets the type of the project item as a GUID string. Use the Type String property to return the type as a string.	Read Only	Yes
35B53C01	Name	Gets the name of the referenced project item as it is saved in the file.	Read Only	Yes
35B53C02	Path	Gets the path of the referenced project item.	Read Only	Yes
35B53C03	Icon	Gets the icon of the project item in the Project Explorer window using the Icon cluster, which limits size and color depth.	Read Only	Yes
35B53C04	Visible In Tree	If TRUE, indicates that the Project Explorer window is visible and ancestors of the project item are expanded in the Project Explorer window up to the root of the project item.	Read Only	No
35B53C05	Project	Returns a reference to the LabVIEW project to which the referenced project item belongs. You can use this reference with the Project properties.	Read Only	Yes
35B53C06	Item ID	Gets the item ID of the referenced project item as a string. You can use this item ID to uniquely identify the referenced item even if the path, name, or location in the Project Explorer window changes.	Read Only	Yes
35B53C07	VI Reference	If the project item refers to a VI, this property returns a reference to the VI. Otherwise, this property returns Not a Refnum. You can use this reference with the VI properties.	Read Only	Yes
35B53C08	Owned Items[]	Returns an array of references to the contents of the referenced project item. You can use these references with the ProjectItem properties.	Read Only	Yes
35B53C09	Owner	Returns a reference to the project item that contains the referenced project item in the Project Explorer window. You can use this reference with the ProjectItem properties.	Read Only	Yes
35B53C0B	NIIM		Read Only	No
35B53C0C	Variable Reference	Returns a reference to the variable the referenced project item references. If the referenced project item is not a variable item, this property returns Not a Refnum. You can use this reference with the Variable properties to configure shared variables programmatically.	Read Only	Yes
35B53C0D	Display Name	Gets as a string the name of the project item as the name appears in the Project Explorer window.	Read Only	Yes
35B53C0E	Is Visible		Read Only	No
35B53C0F	Possible Child Types:All		Read Only	No
35B53C10	Can Get VIReference		Read Only	No
35B53C11	Type String	Gets the type of the project item as a string. Use the Type GUID property to return the type as a GUID.	Read Only	Yes
35B53C12	Library Item:Type	Gets the type of the project item as it exists in the project library as a GUID string. If the item is not part of a library, this property returns an error. Use the Library Item Type:String property to return the type as a human-readable string.	Read Only	Yes
35B53C13	Library Item Type:String	Returns the type of the project item as it exists in the project library as a string. This property returns an error if the project item is not part of a library. Use the Library Item:Type property to return the type as a GUID.	Read Only	Yes
35B53C14	Is Provider Bound		Read Only	No
35B53C16	Target	Returns a reference to the target that contains the referenced project item. You can use this reference with the TargetItem properties.	Read Only	Yes
35B53C17	Possible Child Types:Menu		Read Only	No
35B53C18	Possible Child Types:Dialog		Read Only	No
35B53C19	Suppress Change Notifications		Read/Write	No
35B53C1A	Special Dependency Descendents		Read Only	No
35B53C1B	Found?		Read Only	Yes
35B53C1C	HyperLink Address	Gets or sets the address of a hyperlink item.	Read/Write	Yes (Read Only)
35B53C1D	VI Reference No Load	If the project item refers to a VI in memory, this property returns a reference to the VI. If the project item refers to a VI not in memory or to something that is not a VI, this property returns Not a Refnum. You can use this reference with the VI properties.	Read Only	Yes
35B53C1E	Get Auto-populating Folder Path	Returns the path on disk this auto-populating folder is connected to.	Read Only	Yes
35B53C1F	Source ID		Read/Write	Yes
35B53C20	Hidden Library		Read/Write	Yes
35B53C21	Enabled	Applicable in IIO only. Tasks and program VIs can be set to Enabled, in which case they will be deployed and run on the Controller.	Read/Write	No
35B53C24	Find:Missing Items	Returns all project items that have a path but do not exist on disk.	Read Only	No
35B53C26	Find:Callers	Returns an array of references to all project items that reference the project item you select.	Read Only	No
35B53C27	Find:SubVIs	Returns an array of references to all project items that are subVIs of the item you select.	Read Only	No
35B53C28	Find:Items with No Callers	Returns an array of references to all top-level project items that call no other project items.	Read Only	No
35B53C29	Find:Conflicts	Returns an array of references to all project items that are in conflict with the project item you select.	Read Only	No
35B53C2A	In Conflict?	Returns TRUE if this item conflicts with another item with a different path under the same target.	Read Only	Yes
35B53C2B	Contains Conflicts?	Returns TRUE if this item or items beneath this item in the project tree are in conflict.	Read Only	Yes
35B53C2C	Locked for Edits		Read Only	Yes
35B53C2D	Can Be Replaced		Read Only	Yes
35B53C2E	Faceplate Path		Read/Write	Yes
35B53C2F	TagSet		Read Only	Yes
35B53C30	Can Be Renamed?		Read Only	No
35B53C31	Can Be Removed?		Read Only	No
35B53C32	Files View Item		Read/Write	Yes
35B53C33	Find:Children	Returns an array of references to all project items that are children of the project item you select.	Read Only	No
35B53C34	Find:Friends	Returns an array of references to all project items that are friends of the project item you select.	Read Only	No
35B53C35	Find:Items that make this a dependency	Returns an array of references to all project items under the target that are not under dependencies but cause this item to be under dependencies.	Read Only	No
35B53C36	Missing?		Read Only	Yes
35B53C37	Can Contain Variable		Read Only	Yes
35B53C38	Find:Variable Callers	Returns an array of references to all project VIs that reference the shared variable project item you specify.	Read Only	No
35B53C39	Is In Packed Library	Returns TRUE if a packed project library contains the project item.	Read Only	Yes
35B53C3A	Packed Library		Read Only	Yes
35B53C3B	Find:Items Incorrectly Claimed by a Library	Returns an array of references to all items within a project that are claimed by a library but do not reciprocate the claim.	Read Only	No
35B53C3C	Is In Packed Library And Not Exported		Read Only	Yes
35B53C3D	Is Packed Library		Read Only	Yes
35B53C3E	Is Variable Namespace?		Read Only	No

Methods

Show/Hide ProjectItem Properties Table

Legend
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

ProjectItem Methods Table

Method ID	Long Name (English)	Description	RTE
35B53800	Add File	Adds a file at the specified path to the LabVIEW project with the referenced project item as the parent. You also can use the Project Explorer window to add a file to a project.	No
35B53801	Add Item	Adds a new project item of the specified type to the LabVIEW project with the referenced item as the parent. You also can use the Project Explorer window to add an item to a project.	No
35B53803	Delete	Removes the referenced project item from the LabVIEW project. If the item has children, the children also are deleted. You also can use the Project Explorer window to remove items from the project.	No
35B53809	Close Refee		No
35B5380A	Debug Bind:To Item		No
35B5380B	Debug Bind:To Children		No
35B5380C	Tag:Get Tag	Returns a tag value associated with the project item.	Yes (Read/Write)
35B5380D	Tag:Set Tag	Sets a tag value associated with the LabVIEW project.	No
35B5380E	Tag:Delete	Removes the named tag from the LabVIEW project item.	No
35B5380F	Tag:Get Names	Returns an array of tag names of all tags on the referenced project item.	Yes (Read/Write)
35B53810	Get All Descendents	Recursively returns project items that appear under the referenced item in the project tree. For example, if you call this method on project library A that contains an inner project library B, the method returns items owned both by library A and library B.	Yes (Read/Write)
35B53811	Make Item Visible in Tree		No
35B53812	Select Item		No
35B53813	Simulate:Drag Selection		No
35B53814	Simulate:Copy		No
35B53815	Simulate:Paste		No
35B53816	Simulate:Drag To VI		No
35B53817	Simulate:Paste To VI		No
35B53818	Simulate:Drag From Paths		No
35B53819	Collapse	Hides the contents of an expandable project item in the Project Explorer window. Expandable project items include folders, project libraries, LabVIEW classes, and XControls.	No
35B5381A	Rename		No
35B5381B	New from Template		No
35B5381C	Suppress Project Dialogs		No
35B5381D	Simulate:Notify		No
35B5381E	SCC Get Info		No
35B5381F	Query Behavior		No
35B53820	Move		No
35B53821	Delete Privately (tell no outsiders)		No
35B53822	Tag:Get XML Tag	Returns the value in an XML tag.	Yes (Read/Write)
35B53823	Tag:Set XML Tag	Sets the value of an XML tag associated with the LabVIEW project.	No
35B53824	Add Item From Memory	Adds an item that exists in memory to the LabVIEW project with the referenced project item as the parent.	No
35B53825	Notify Item Changed		No
35B53826	Expand	Displays the contents of an expandable project item in the Project Explorer window. Expandable project items include folders, project libraries, LabVIEW classes, and XControls.	No
35B53827	Arrange By		No
35B53828	Set Url		No
35B53829	Get All Descendents2		Yes
35B5382A	GetFindResults		Yes
35B5382B	Convert to Auto-populating Folder	Connect this project item to a folder on disk.	No
35B5382C	Stop Auto-populating	Disconnect this folder from a folder on disk.	No
35B5382D	Delete On Disk		Yes
35B5382E	List of Refer ProjectItems		Yes
35B5382F	Replace With Item in Project		Yes
35B53830	Choose Substitute		Yes
35B53831	AddMultipleItems		Yes
35B53832	ForceDelete		Yes
35B53833	Bounds		Yes
35B53834	Get Variable URLs		No
35B53835	Add Item From Memory Privately		No
35B53836	Get Library Access Scope		No
35B53837	Replace Item With		No

Events

This class has no events.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server