Jump to content

Template:VIServerPropsTable: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
Editing Template to be the properties lookup table.
Line 1: Line 1:
<includeonly>
<includeonly>{{#ifeq: {{{1|}}} || ''No Properties for this class.'' |
{{#if: {{{2|}}} |
<span class="mw-customtoggle-propertiestable">Show/Hide {{VIServerGetClassName|{{{1}}}}} Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide {{{1}}} Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{{!}} class="wikitable sortable"
{{{!}} class="wikitable sortable"
{{!}}+ Application Properties Table
{{!}}+ {{VIServerGetClassName|{{{1}}}}} Properties Table
! Property ID
! Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! R/W
! R/W
! RTE
! RTE
{{{2}}}
{{!}}-
{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>0</td><td>[[Application:Name property{{!}}Application:Name]]</td><td>Filename of the application.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1</td><td>[[Application:User Name property{{!}}Application:User Name]]</td><td>User name used to open the application.</td><td>R/W</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>2</td><td>[[Application:Version property{{!}}Application:Version]]</td><td>Version number of the application. In a stand-alone application or shared library, this property returns the version of the LabVIEW Run-Time Engine.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>3</td><td>[[Application:Kind property{{!}}Application:Kind]]</td><td>Indicates the LabVIEW instance the VI is running in, including invalid application types.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>4</td><td>[[Application:Target:Operating System property{{!}}Application:Target:Operating System]]</td><td>Indicates the operating system for which the application was built.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>5</td><td>[[Application:Target:CPU property{{!}}Application:Target:CPU]]</td><td>Indicates the target CPU of an application.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>6</td><td>[[Operating System:Name property{{!}}Operating System:Name]]</td><td>Name of the operating system where the application is actually running.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1F4</td><td>[[VI Name property{{!}}VI Name]]</td><td>Name of the VI file. If a LabVIEW project library owns the VI, the property returns the qualified name of the VI, which includes the project library filename.</td><td>R/W</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1F5</td><td>[[VI Path property{{!}}VI Path]]</td><td>Path to the VI file.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1F6</td><td>[[VI Description property{{!}}VI Description]]</td><td>Description of the VI that appears in the Context Help window when you move the cursor over the VI icon and in VI documentation you generate.</td><td>R/W</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#FFFFCC;"><td>6327800</td><td>[[Class ID property{{!}}Class ID]]</td><td>Class identifier of the object.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#FFAAAA;"><td>6327801</td><td>Owner (Deprecated)</td><td>Reference to the owning object.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#FFFFCC;"><td>6327802</td><td>[[Owning VI property{{!}}Owning VI]]</td><td>Returns a reference to the VI that owns this object.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#FFFFCC;"><td>6327803</td><td>[[Class Name property{{!}}Class Name]]</td><td>Name of the VI Server class that contains the object.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#D1BB80;"><td>6327804</td><td>[[Modified property{{!}}Modified ]]</td><td>Property pages use this for generic get/set of properties.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#CCFFFF;"><td>6327805</td><td>[[Is On Block Diagram? property{{!}}Is On Block Diagram?]]</td><td>Returns TRUE when the object is located on the block diagram.</td><td>R</td><td>X</td></tr>
|}}{{#ifeq: {{{1|}}} | 3 | <tr style="background-color:#FFFFCC;"><td>6327806</td><td>[[Owner property{{!}}Owner]]</td><td>Reference to the owning object.</td><td>R</td><td>X</td></tr>
|}}
{{!}}}
{{!}}}
</div>
</div>
|''No Properties for this class.''}}
}}
</includeonly>
</includeonly>
<noinclude>
<noinclude>
Line 20: Line 37:
== Usage ==
== Usage ==


Use this template is for [[VI Server Class Hierarchy]] class pages. This template supports named parameters to customize contents:
This template contains a lookup table for all of the properties It is used in the [[VI Server Class Hierarchy]] class pages. 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.


{| class="wikitable"
{| class="wikitable"
Line 28: Line 45:
|-
|-
| <code>{{{1}}}</code>
| <code>{{{1}}}</code>
| The class name.
| The class ID.
| <code></code>
| <code>Blank - Translates into message: ''No Properties for this class.''</code>
|-
| <code>{{{2}}}</code>
| Array of Rows using the template, [[Template:VIServerPropTableRow]]
| <code>Blank or null means there are no properties.  The table won't be displayed, instead the text: "''No Properties for this class.''" is displayed.</code>
|}
|}


Line 43: Line 56:
</nowiki>
</nowiki>
</code>
</code>


{{VIServerPropsTable}}
{{VIServerPropsTable}}


 
'''Example: Properties Exist - Application Class'''
'''Example: Properties Exist'''


<code>
<code>
<nowiki>
<nowiki>
{{VIServerPropsTable|Control|
{{VIServerPropsTable|1}}
{{VIServerPropTableRow|Control|Auto-Update|633201C|script|R/W|X|If TRUE, the control automatically updates when the type definition changes.}}
</nowiki>
{{VIServerPropTableRow|Control|Blinking|6332003|basic|R/W|X|If TRUE, the control blinks.
</code>
 
 
{{VIServerPropsTable|1}}


Keep in mind the following caveats when using this property:


*If you set this property to TRUE for system controls, the controls might not blink correctly. System controls are designed specifically for use in dialog boxes and are not designed to blink because standard dialog boxes usually do not contain blinking controls.
'''Example: Properties Exist - VI Class'''
*You cannot use this property with XControls or controls on a subpanel.
*Do not use this property with elements in an array. This property works on only one element in the array, not the entire array. Use a cluster instead of an array to make all the elements blink.


This property is similar to the <b>Blink Foreground</b> and <b>Blink Background</b> options on the Environment page of the Options dialog box, and to the <b>Blink delay for front panel controls (milliseconds)</b> option on the Front Panel page of the <b>Options</b> dialog box.}}
<code>
}}
<nowiki>
{{VIServerPropsTable|2}}
</nowiki>
</nowiki>
</code>
</code>


{{VIServerPropsTable|Control|
{{VIServerPropTableRow|Control|Auto-Update|633201C|script|R/W|X|If TRUE, the control automatically updates when the type definition changes.}}
{{VIServerPropTableRow|Control|Blinking|6332003|basic|R/W|X|If TRUE, the control blinks.
Keep in mind the following caveats when using this property:


*If you set this property to TRUE for system controls, the controls might not blink correctly. System controls are designed specifically for use in dialog boxes and are not designed to blink because standard dialog boxes usually do not contain blinking controls.
{{VIServerPropsTable|2}}
*You cannot use this property with XControls or controls on a subpanel.
*Do not use this property with elements in an array. This property works on only one element in the array, not the entire array. Use a cluster instead of an array to make all the elements blink.


This property is similar to the <b>Blink Foreground</b> and <b>Blink Background</b> options on the Environment page of the Options dialog box, and to the <b>Blink delay for front panel controls (milliseconds)</b> option on the Front Panel page of the <b>Options</b> dialog box.}}
}}


'''Example: Can't use with nested tables'''
'''Example: Properties Exist - Generic Class'''


<code>
<code>
<nowiki>
<nowiki>
{{VIServerPropsTable|Control|
{{VIServerPropsTable|3}}
{{VIServerPropTableRow|Control|BindingStatus|633202A|script|R|X|Returns the status of the data connection. The connection status can be Invalid Status, Unconnected, Active, Idle, Error, or Connecting.
 
<table class="wikitable">
<caption style="text-align:left;">Elements:</caption>
<tr><th scope="col" style="text-align:left;">Name</th>
<tr><th scope="col" style="text-align:left;">Description</th></tr>
<tr style="vertical-align:top;">
<td scope="row" style="text-align:left;">Code</td>
<td>The connection status. Valid values are Invalid Status, Unconnected, Active, Idle, Error, or Connecting.</td></tr>
<tr style="vertical-align:top;">
<td scope="row" style="text-align:left;">Text</td>
<td>Displays a message describing the current status.</td></tr></table>}}
}}
</nowiki>
</nowiki>
</code>
</code>


{{VIServerPropsTable|Control|
{{VIServerPropTableRow|Control|BindingStatus|633202A|script|R|X|Returns the status of the data connection. The connection status can be Invalid Status, Unconnected, Active, Idle, Error, or Connecting.


<table class="wikitable">
{{VIServerPropsTable|3}}
<caption style="text-align:left;">Elements:</caption>
 
<tr><th scope="col" style="text-align:left;">Name</th>
<tr><th scope="col" style="text-align:left;">Description</th></tr>
<tr style="vertical-align:top;">
<td scope="row" style="text-align:left;">Code</td>
<td>The connection status. Valid values are Invalid Status, Unconnected, Active, Idle, Error, or Connecting.</td></tr>
<tr style="vertical-align:top;">
<td scope="row" style="text-align:left;">Text</td>
<td>Displays a message describing the current status.</td></tr></table>}}
}}


</noinclude>
</noinclude>

Revision as of 16:23, 6 September 2019


 This page is under construction.
This page or section is currently in the middle of an expansion or major revamping.

However, you are welcome to assist in its construction by editing it as well. Please view the edit history should you wish to contact the person who placed this template. If this article has not been edited in several days please remove this template. Please don't delete this page unless the page hasn't been edited in several days.

While actively editing, consider adding {{inuse}} to reduce edit conflicts.

Usage

This template contains a lookup table for all of the properties It is used in the VI Server Class Hierarchy class pages. 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 - Application Class

{{VIServerPropsTable|1}}


Show/Hide Application Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Application Properties Table
Property ID Long Name (English) Description R/W RTE
0Application:NameFilename of the application.RX
1Application:User NameUser name used to open the application.R/WX
2Application:VersionVersion number of the application. In a stand-alone application or shared library, this property returns the version of the LabVIEW Run-Time Engine.RX
3Application:KindIndicates the LabVIEW instance the VI is running in, including invalid application types.RX
4Application:Target:Operating SystemIndicates the operating system for which the application was built.RX
5Application:Target:CPUIndicates the target CPU of an application.RX
6Operating System:NameName of the operating system where the application is actually running.RX



Example: Properties Exist - VI Class

{{VIServerPropsTable|2}}


Show/Hide VI Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
VI Properties Table
Property ID Long Name (English) Description R/W RTE
1F4VI NameName of the VI file. If a LabVIEW project library owns the VI, the property returns the qualified name of the VI, which includes the project library filename.R/WX
1F5VI PathPath to the VI file.RX
1F6VI DescriptionDescription of the VI that appears in the Context Help window when you move the cursor over the VI icon and in VI documentation you generate.R/WX



Example: Properties Exist - Generic Class

{{VIServerPropsTable|3}}


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.RX
6327801Owner (Deprecated)Reference to the owning object.RX
6327802Owning VIReturns a reference to the VI that owns this object.RX
6327803Class NameName of the VI Server class that contains the object.RX
6327804Modified Property pages use this for generic get/set of properties.RX
6327805Is On Block Diagram?Returns TRUE when the object is located on the block diagram.RX
6327806OwnerReference to the owning object.RX



Retrieved from "https://labviewwiki.org/w/index.php?title=Template:VIServerPropsTable&oldid=9609"