Template:VIServerProperty: Difference between revisions
m Fixed problem where extra space was showing up. |
m Move documentation to subpage |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{| class="wikitable" style="float: | <includeonly>{| class="wikitable" style="float:left; margin-right: 20px;" | ||
! colspan="2" | VI Server Property Information | ! colspan="2" | VI Server Property Information | ||
|- | |- | ||
| Line 27: | Line 27: | ||
! scope="row" style="text-align:left;" | Data Type | ! scope="row" style="text-align:left;" | Data Type | ||
| [[{{{datatype}}} data type]] | | [[{{{datatype}}} data type]] | ||
[[File:{{{datatypeimage}}}|frameless|border|{{{datatype}}}|link={{{datatype}}}]] | [[File:{{{datatypeimage}}}|frameless|border|{{{datatype}}}|link={{{datatype}}} data type]] | ||
|- | |- | ||
! scope="row" style="text-align:left;" | Property Node | ! scope="row" style="text-align:left;" | Property Node | ||
| Line 45: | Line 45: | ||
|}}{{#if: {{{settablewhenrunning|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Settable when the VI is running</b></td><td>{{{settablewhenrunning}}}</td></tr> | |}}{{#if: {{{settablewhenrunning|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Settable when the VI is running</b></td><td>{{{settablewhenrunning}}}</td></tr> | ||
|}} | |}} | ||
|}</includeonly> | |}</includeonly><noinclude>{{documentation}}</noinclude> | ||
<noinclude> | |||
{{ | |||
}} | |||
</noinclude> | |||
Latest revision as of 17:03, 1 August 2024
This documentation is transcluded from Template:VIServerProperty/doc (history).
Usage
Use this template is to create the Property Information table in VI Server property pages.
Syntax is as follows:
{{VIServerProperty
| classid =
| propertyid =
| scope =
| dataname =
| shortname =
| longname =
| datatypeimage =
| datatype =
| propertynodeimage =
| availableinrealtime =
| availableinruntime =
| availablewithcontrolvis =
| availablewithglobalvis =
| availablewithpolyvis =
| availablewithstricttypedefs =
| loadsbd =
| loadsfp =
| mustwait =
| needsauthentication =
| permissions =
| remoteallowed =
| settablewhenrunning =
|}}
where:
| Parameter | Description | Default |
|---|---|---|
classid
|
The Class ID of a class in the VI Server Class Hierarchy. | |
propertyid
|
The Property ID of the property owned by the class defined by the Class ID {{{classid}}}. | |
scope
|
The scope of the property as either {basic, script, private, deprecated}. | |
dataname
|
The data name of the property. | |
shortname
|
The short name of the property. | |
longname
|
The long name of the property. | |
datatypeimage
|
The filename to the wiki image for the data type terminal for the property. | |
datatype
|
The data type of the property. | |
propertynodeimage
|
The filename to the wiki image for the property node for the property. | |
availableinrealtime
|
The value for "Available in Real-Time Operating System". | |
availableinrealtime
|
The value for "Available in Real-Time Operating System". | |
availableinruntime
|
The value for "Available in Run-Time Engine". | |
availablewithcontrolvis
|
The value for "Available with control VIs". | |
availablewithglobalvis
|
The value for "Available with global VIs". | |
availablewithpolyvis
|
The value for "Available with polymorphic VIs". | |
availablewithstricttypedefs
|
The value for "Available with strict type definitions". | |
loadsbd
|
The value for "Loads the block diagram into memory". | |
loadsfp
|
The value for "Loads the front panel into memory". | |
mustwait
|
The value for "Must wait until user interface is idle". | |
needsauthentication
|
The value for "Need to authenticate before use". | |
permissions
|
The value for "Permissions". | |
remoteallowed
|
The value for "Remote access allowed". | |
settablewhenrunning
|
The value for "Settable when the VI is running". | |
Example
{{VIServerProperty| classid = 36
| propertyid = 632A813
| scope = script
| dataname = UID
| shortname = UID
| longname = UID
| datatypeimage = I32.png
| datatype = I32
| propertynodeimage = GObject-UID.png
| availableinrealtime = Yes
| availableinruntime = Yes
| loadsbd = No
| loadsfp = No
| needsauthentication = No
| permissions = Read Only
| remoteallowed = Yes
| settablewhenrunning = No
}}
Result
VI Server Property Information Property ID 632A813 Scope VI Scripting Data Name UID Short Name* UID Long Name* UID * Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE. Owning Class ID 36 Owning Class Name GObject Class Data Type I32 data type
Property Node 
Available in Real-Time Operating System Yes Available in Run-Time Engine Yes Loads the block diagram into memory No Loads the front panel into memory No Need to authenticate before use No Permissions Read Only Remote access allowed Yes Settable when the VI is running No
