Template:VIServerPropsTable: Difference between revisions
m Changed Examples |
Changed behavior using VIServerHasProperties lookup |
||
| Line 1: | Line 1: | ||
<includeonly>{{#ifeq: {{{1 | <includeonly>{{#ifeq: {{VIServerHasProperties|{{{1}}}}} | FALSE | ''No Properties for this class.'' |<span class="mw-customtoggle-propertiestable">Show/Hide {{VIServerGetClassName|{{{1}}}}} Properties Table</span> | ||
<span class="mw-customtoggle-propertiestable">Show/Hide {{VIServerGetClassName|{{{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}} | ||
| Line 2,668: | Line 2,667: | ||
|}}{{#ifeq: {{{1|}}} | 51 | <tr style="background-color:#FFFFCC;"><td>E67CB803</td><td>[[IVILogicalName class/Value (Signaling) property{{!}}Value (Signaling)]]</td><td>Sets the value of the control and generates a Value Change event.</td><td>Write Only</td><td>Yes </td></tr> | |}}{{#ifeq: {{{1|}}} | 51 | <tr style="background-color:#FFFFCC;"><td>E67CB803</td><td>[[IVILogicalName class/Value (Signaling) property{{!}}Value (Signaling)]]</td><td>Sets the value of the control and generates a Value Change event.</td><td>Write Only</td><td>Yes </td></tr> | ||
|}} | |}} | ||
{{!}}} | {{!}}}</div>}}</includeonly> | ||
</div> | |||
}} | |||
</includeonly> | |||
<noinclude> | <noinclude> | ||
{{underconstruction}} | {{underconstruction}} | ||
| Line 2,688: | Line 2,684: | ||
|} | |} | ||
'''Example: No Properties Exists''' | '''Example: No Properties Exists - {{VIServerGetClassName|10}} Class''' | ||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerPropsTable}} | {{VIServerPropsTable|10}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
{{VIServerPropsTable}} | {{VIServerPropsTable|10}} | ||
'''Example: Properties Exist - | '''Example: Properties Exist - {{VIServerGetClassName|3}} Class''' | ||
<code> | <code> | ||
| Line 2,705: | Line 2,702: | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
{{VIServerPropsTable|3}} | {{VIServerPropsTable|3}} | ||
'''Example: Passing a null value.''' | |||
'' | ''Passing a null value defaults to no properties.'' | ||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerPropsTable | {{VIServerPropsTable}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
{{VIServerPropsTable}} | |||
{{VIServerPropsTable | |||
</noinclude> | </noinclude> | ||
Revision as of 05:32, 8 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 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 - LVVariant Class
{{VIServerPropsTable|10}}
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 | |
| 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: Passing a null value.
Passing a null value defaults to no properties.
{{VIServerPropsTable}}
No Properties for this class.