Template:VIServerPropsTable: Difference between revisions

Revision as of 13:15, 7 September 2019

Usage

This template contains a lookup table for all of the properties. It is used in the VI Server Class Hierarchy class pages to display the properties tables. The parameter is either the Class ID number where the list is then filtered to properties of that class, or the parameter is left blank to signify this class has no properties.

Parameter	Description	Default
`{{{1}}}`	The class ID.	`Blank - Translates into message: No Properties for this class.`

Example: No Properties Exists

{{VIServerPropsTable}}

No Properties for this class.

Example: Properties Exist - Generic Class

{{VIServerPropsTable|3}}

Show/Hide Generic Properties Table

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

Generic Properties Table
Property ID	Long Name (English)	Description	R/W	RTE
6327800	Class ID	Class identifier of the object.	Read Only	Yes (Read Only)
6327801	Owner (Deprecated)		Read Only	Yes
6327802	Owning VI	Returns a reference to the VI that owns this object. Close this reference when you are finished using it. The reference this property returns does not keep the VI in memory. If the owning VI is removed from memory, this reference becomes invalid. Use the Open VI Reference function to obtain a reference to a VI that stays in memory until you explicitly close the reference.	Read Only	Yes (Read Only)
6327803	Class Name	Name of the VI Server class that contains the object.	Read Only	Yes (Read Only)
6327804	Modified		Read Only	Yes
6327805	Is On Block Diagram?	Returns TRUE when the object is located on the block diagram.	Read Only	Yes
6327806	Owner	Reference to the owning object. The type of the reference is Generic. An object of class Panel does not have an owner (it is the top-level object) and always returns `Not A Refnum`.	Read Only	Yes (Read Only)

Example: Properties Exist - GObject Class

{{VIServerPropsTable|36}}

Show/Hide GObject Properties Table

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

GObject Properties Table
Property ID	Long Name (English)	Description	R/W	RTE
632A800	Position	Position of the top left corner of the bounding rectangle of the object on the front panel window in terms of left and top coordinates.	Read/Write	Yes
632A801	Position:Left	Position of the left corner of the bounding rectangle of the object on the front panel window.	Read/Write	Yes
632A802	Position:Top	Position of the top corner of the bounding rectangle of the object on the front panel window.	Read/Write	Yes
632A803	Bounds	Maximum bounding area of the object specified in terms of width and height in pixels.	Read Only	Yes (Read Only)
632A804	Bounds:Area Width	Width of the maximum bounding area of the object in pixels.	Read Only	Yes (Read Only)
632A805	Bounds:Area Height	Height of the maximum bounding area of the object in pixels.	Read Only	Yes (Read Only)
632A806	Grouped		Read Only	Yes
632A807	Locked		Read Only	Yes
632A808	Group Member Refs[]		Read Only	Yes
632A809	Selected	Returns TRUE if the GObject is selected.	Read/Write	Yes
632A80A	Total Bounds Rect	Returns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object.	Read Only	Yes
632A80B	Master Bounds Rect	Returns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object.	Read Only	Yes
632A80C	Basic Object Flags		Read/Write	No
632A80D	Is Wizard Locked		Read Only	Yes
632A80F	Resize Info:Can Resize Horizontally		Read Only	Yes
632A810	Resize Info:Can Resize Vertically		Read Only	Yes
632A811	Resize Info:Name in Resize Dialog		Read Only	Yes
632A812	Resize Info:Include In Resize		Read Only	Yes
632A813	UID	Returns the unique identifier (UID) for the object. UIDs are identifiers for LabVIEW objects and are always unique within the same VI. Inspect the UID of an object to verify that it is the exact object that you want to manipulate.	Read Only	Yes
632A814	Dependencies:Missing Dependency Paths		Read Only	No
632A815	Dependencies:Missing Dependency Names		Read Only	No
632A816	Dependencies:Found Dependency Paths		Read Only	No
632A817	Dependencies:Found Dependency Names		Read Only	No

Example: Properties Exist - LVClassLibrary Class

{{VIServerPropsTable|85}}

Show/Hide LVClassLibrary Properties Table

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

LVClassLibrary Properties Table
Property ID	Long Name (English)	Description	R/W	RTE
97D7002	Simple Name	Returns the name of the class without prepending namespace information from owning classes.	Read Only	No
97D7003	Parent Class	Gets or sets the LabVIEW class from which the referenced class directly inherits.	Read/Write	No
97D7004	Children In Memory[]	Returns an array of references to all LabVIEW classes in memory that directly inherit from the referenced class. This property does not return additional descendents of the child classes.	Read Only	No
97D7005	Properties		Read Only	Yes
97D7006	Dynamic Member VIs		Read Only	Yes
97D7007	Static Member VIs		Read Only	Yes
97D7009	Name Visible In Probe		Read/Write	Yes
97D700A	Wire Pens	Gets or sets the appearance of the wire associated with this LabVIEW class.	Read/Write	No
97D700B	Default Instance		Read Only	No
97D700D	Probes		Read Only	Yes
97D700E	Modification Date		Read Only	Yes
97D700F	Private Data Control	Returns a reference to the control that contains the private data of this LabVIEW class.	Read Only	No
97D7010	DefaultProbe	Returns a reference to the default probe for the LabVIEW class library. The default probe is the probe LabVIEW uses when you first create a probe from a wire of this class type.	Read/Write	No
97D7011	Transfer Must Overrides?	Determines whether to allow the class to transfer all override requirements to any descendant classes instead of overriding the dynamic dispatch VI itself.	Read/Write	No
97D7012	Self References Restricted	Property indicates that data value references to this class can only be created/deleted by member VIs of this class.	Read/Write	No
97D7013	Child References Restricted	Property indicates whether data value references to all of this class descendants can be created only in member VIs of this class.	Read/Write	No
97D7014	Ancestor Restricts Reference Creation	Property indicates that an ancestor class controls the creation of data value references to this class. Only the ancestors member VIs can create data value references.	Read Only	No
97D7015	Dynamic Member VIs[]	Returns an array of references to the member VIs of the referenced LabVIEW class that contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that do not contain a dynamic dispatch terminal, use the Static Member VIs() property.	Read Only	No
97D7016	Static Member VIs[]	Returns an array of references to the members VIs of the referenced LabVIEW class that do not contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that contain a dynamic dispatch terminal, use the Dynamic Member VIs() property.	Read Only	No

@@ Line 2,698: / Line 2,698: @@
 {{VIServerPropsTable}}
-'''Example: Properties Exist - Application Class'''
+'''Example: Properties Exist - Generic Class'''
 <code>
 <nowiki>
-{{VIServerPropsTable|1}}
+{{VIServerPropsTable|3}}
 </nowiki>
 </code>
-{{VIServerPropsTable|1}}
+{{VIServerPropsTable|3}}
-'''Example: Properties Exist - VI Class'''
+'''Example: Properties Exist - GObject Class'''
 <code>
 <nowiki>
-{{VIServerPropsTable|2}}
+{{VIServerPropsTable|36}}
 </nowiki>
 </code>
-{{VIServerPropsTable|2}}
+{{VIServerPropsTable|36}}
-'''Example: Properties Exist - Generic Class'''
+'''Example: Properties Exist - {{VIServerGetClassName|85}} Class'''
 <code>
 <nowiki>
-{{VIServerPropsTable|3}}
+{{VIServerPropsTable|85}}
 </nowiki>
 </code>
-{{VIServerPropsTable|3}}
+{{VIServerPropsTable|85}}
 </noinclude>