Jump to content

ProjectItem class

From LabVIEW Wiki
Revision as of 16:35, 25 August 2019 by Q (talk | contribs) (Started page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
<VI Server Class Hierarchy

The ProjectItem class is a class in the VI Server Class Hierarchy, (see also VI Server). The ProjectItem class is the top-level class for most of the objects that are used on the Items tab of the Project Explorer window.

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

Application Properties Table
Property ID Short Name (English) Description R/W RTE
35B53C31 Can Be Removed? R
35B53C30 Can Be Renamed? R
35B53C2D Can Be Replaced R X
35B53C37 CanContainVariable R X
35B53C10 CanGetVIReference R
35B53C2B Contains Conflicts? Returns TRUE if this item or items beneath this item in the project tree are in conflict. R X
35B53C0D DisplayName Gets as a string the name of the project item as the name appears in the Project Explorer window.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
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. R/W
35B53C2E Faceplate Path R/W X
35B53C32 Files View Item R/W X
35B53C26 Find Callers Returns an array of references to all project items that reference the project item you select.

This property is similar to the Find»Callers item on the shortcut menu of a project item.

R
35B53C33 Find Children Returns an array of references to all project items that are children of the project item you select. R
35B53C29 Find Conflicts Returns an array of references to all project items that are in conflict with the project item you select.

This property is similar to the Find»Conflicts item on the shortcut menu of a project item.

R
35B53C34 Find Friends Returns an array of references to all project items that are friends of the project item you select. R
35B53C3B Find Items Incorrectly Claimed by Library Returns an array of references to all items within a project that are claimed by a library but do not reciprocate the claim. R
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. R
35B53C28 Find Items with No Callers Returns an array of references to all top-level project items that call no other project items.

This property is similar to the Find»Items with No Callers item on the shortcut menu of a project item.

R
35B53C24 Find Missing Items Returns all project items that have a path but do not exist on disk. R
35B53C27 Find SubVIs Returns an array of references to all project items that are subVIs of the item you select.

This property is similar to the Find»SubVIs item on the shortcut menu of a project item.

R
35B53C38 Find Variable Callers Returns an array of references to all project VIs that reference the shared variable project item you specify. R
35B53C1B Found? R X
35B53C1E Auto-Populating Path Returns the path on disk this auto-populating folder is connected to. R X
35B53C20 HiddenLibrary R/W X
35B53C1C Hyperlink Address Gets or sets the address of a hyperlink item.

This property is similar to the options available in the Hyperlink Properties dialog box.

R/W X
35B53C03 Icon Gets the icon of the project item in the Project Explorer window using the Icon cluster, which limits size and color depth.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine. Elements

Name Description

Image Type Reserved for future use.

Image Depth Specifies the color depth of the image, which is the number of bits to use to describe the color of each pixel in the image. Valid values include 1, 4, 8, and 24 bits per pixel. Image Depth affects how LabVIEW interprets the values of Image and Colors.

Image A 1-D array of bytes that describes the color of each pixel in the image in raster order. The value of Image Depth determines how LabVIEW interprets the value of this input.

If Image Depth is 24, each pixel has three bytes to describe its color. The first byte for each pixel describes the red value, the second byte describes the green value, and the third byte describes the blue value.

If Image Depth is 8, each pixel has one byte to describe its color. The value of each bit corresponds to an element in Colors, which stores 32-bit RGB values where the most-significant byte is zero, followed in order by red, green, and blue values. Valid values include 0 through 255.

If Image Depth is 4, the behavior is similar to when Image Depth is 8 except valid values in image include 0 through 15.

If Image Depth is 1, any value of zero in Image corresponds to element 0 in Colors. All other values correspond to element 1 in Colors.

Mask An array of bytes in which each bit describes mask information for a pixel. The first byte describes the first eight pixels, the second byte describes the next eight pixels, and so on. If a bit is zero, LabVIEW draws the corresponding pixel as transparent. If the array is empty, LabVIEW draws all pixels without transparency. If the array does not contain a bit for each pixel in the image, LabVIEW draws any pixels missing from the array without transparency.

Colors An array of RGB color values that correspond to the values in image. The value of Image Depth determines how LabVIEW interprets the value of this input.

If Image Depth is 24, LabVIEW ignores this input.

If Image Depth is 8, the array can have 256 elements.

If Image Depth is 4, the array can have 16 elements.

If Image Depth is 1, the array can have 2 elements.


Rectangle A cluster that contains coordinates that describe the bounding rectangle in which you want to draw the image. The VI clips the image to the width and height of the rectangle. The bottom and right edges of the rectangle bounds do not contain image pixels. Horizontal coordinates increase to the right, and vertical coordinates increase to the bottom.

Left—The horizontal coordinate of the left edge of the rectangle. Top—The vertical coordinate of the top edge of the rectangle. Right—The horizontal coordinate of the right edge of the rectangle. Bottom—The vertical coordinate of the bottom edge of the rectangle.

R X
35B53C2A In Conflict? Returns TRUE if this item conflicts with another item with a different path under the same target. R X
35B53C39 IsInPackedLibrary Returns TRUE if a packed project library contains the project item. R X
35B53C3C IsInPackedLibraryAndNotExported R X
35B53C3D IsPackedLibrary R X
35B53C14 IsProviderBound R
35B53C3E IsVarNamespace? R
35B53C0E IsVisible R
35B53C06 ItemID 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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C13 LibraryItemTypeString 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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C12 LibraryItemType 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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C2C Locked for Edits R X
35B53C36 Missing? R X
35B53C0B NIIM R
35B53C01 Name Gets the name of the referenced project item as it is saved in the file.

Use the Display Name property to get the name as it appears in the Project Explorer window.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C08 OwnedItems() Returns an array of references to the contents of the referenced project item. 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. Example

R X
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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C3A PackedLibrary R X
35B53C02 Path Gets the path of the referenced project item.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C0F PossibleChildTypes() R
35B53C18 PossibleDialogChildTypes() R
35B53C17 PossibleMenuChildTypes() R
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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C1F SourceID R/W X
35B53C1A SpecialDependencyDescendents R
35B53C19 SuppressChangeNotifications R/W
35B53C2F TagSet R X
35B53C16 Target Returns a reference to the target that contains the referenced project item. 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
35B53C00 Type Gets the type of the project item as a GUID string. Use the Type String property to return the type as a string.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C11 TypeString Gets the type of the project item as a string. Use the Type GUID property to return the type as a GUID.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C07 VIReference 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.

Note The VI Reference does not record changes to the VI. If you use this reference for editing the VI, you will not be prompted to save when the reference closes. Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C1D VIReferenceNoLoad 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. R X
35B53C0C VariableReference 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.

Note You can create, configure, and host shared variables only on Windows or RT targets with the LabVIEW Real Time Module. You can use the DataSocket VI and functions to read or write shared variables from other platforms. Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R X
35B53C04 VisibleInTree 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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R

Methods

Show/Hide Application Methods Table

Application Methods Table
Method ID Short Name (English) Description RTE
35B53800 AddFile 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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. Example

35B53801 AddItem 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.

This method returns an error if the specified type cannot be created under the current item. The method also returns an error when you try to add a shared variable to a library that is not opened in a project.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine. Example

35B53824 AddItemFromMemory Adds an item that exists in memory to the LabVIEW project with the referenced project item as the parent.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

35B53835 AddItemFromMemoryPrivately
35B53831 AddMultipleItems X
35B53827 Arrange By
35B53833 Bounds X
35B53830 Choose Substitute X
35B53809 CloseRefee
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.
35B5382B Convert to Auto-populating Folder Connect this project item to a folder on disk.

This property is similar to the Convert to Auto-populating Folder item on the shortcut menu of a virtual folder in the project.

35B5380B Debug Bind To Children
35B5380A Debug Bind To Item
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.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

35B5382D Delete On Disk X
35B53821 Delete Privately
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.
35B53832 ForceDelete X
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.

For this method, the term descendents does not refer to children classes of the referenced project item.

X
35B53829 Get All Descendents2 X
35B53836 Get Library Access Scope
35B53834 GetVariableURLs
35B5382A GetFindResults X
35B5382E ListOfReferProjItems X
35B53811 Make Item Visible in Tree
35B53820 Move
35B5381B New from Template
35B53825 NotifyItemChanged
35B5381F Query Behavior
35B5381A Rename
35B53837 Replace Item With
35B5382F ReplaceWithProjItem X
35B5381E SCC Get Info
35B53812 SelectItem
35B53828 SetUrl
35B53814 Simulate Copy
35B53818 Simulate Drag From Paths
35B53813 SimulateDragSelection
35B53816 Simulate Drag To VI
35B5381D SimulateNotify
35B53815 Simulate Paste
35B53817 Simulate Paste To VI
35B5382C Stop Auto-populating Disconnect this folder from a folder on disk.

This property is similar to the Stop Auto-populating item on the shortcut menu of an auto-populating folder in the project.

35B5381C Suppress Project Dlgs
35B5380E Delete Tag Removes the named tag from the LabVIEW project item.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

35B5380F Get Tag Names Returns an array of tag names of all tags on the referenced project item.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
35B5380C Get Tag Returns a tag value associated with the project item.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
35B53822 Get XML Tag Returns the value in an XML tag.

Use the Tag:Set XML Tag method to set the value in an XML tag.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
35B5380D Set Tag Sets a tag value associated with the LabVIEW project.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

35B53823 Set XML Tag Sets the value of an XML tag associated with the LabVIEW project.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

Events

No Events for this Class

History

History information is needed. What changes have occured over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=ProjectItem_class&oldid=8776"