Template:VIServerPropsTable

From LabVIEW Wiki
Jump to: navigation, search


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 the Class ID number where the list is then filtered to properties of that class if it has any. If the parameter is left blank, the default is that it has no properties.

Syntax

{{VIServerPropsTable|{{{1}}}}}

where:

Parameter Description Default
{{{1}}} The class ID. Blank - Translates into message: This class has no properties.

Example: No Properties Exists

No properties exist for the LVVariant Class.

{{VIServerPropsTable|10}}

Results

This class has no properties or it inherits properties from its parent: Control Class.


Example: Properties Exist

Properties exist for the Decoration Class.

{{VIServerPropsTable|3}}

Results

Show/Hide Generic Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Generic Properties Table
Property ID Long Name (English) Description R/W RTE
6327800Class IDClass identifier of the object.Read OnlyYes (Read Only)
6327801Owner (Deprecated)Read OnlyYes
6327802Owning VIReturns 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 OnlyYes (Read Only)
6327803Class NameName of the VI Server class that contains the object.Read OnlyYes (Read Only)
6327804ModifiedRead OnlyYes
6327805Is On Block Diagram?Returns TRUE when the object is located on the block diagram.Read OnlyYes
6327806OwnerReference 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 OnlyYes (Read Only)


Example: Passing a null value.

Passing a null value defaults to no properties.

{{VIServerPropsTable}}

Results

This class has no properties.


See Also