Jump to content

Template:VIServerPropsTable: Difference between revisions

From LabVIEW Wiki
Fixed VI methods link
Adjusted max height
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:
<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}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{{{!}} class="wikitable sortable"
{{{!}} class="wikitable sortable"
{{!}}+ {{VIServerGetClassName|{{{1}}}}} Properties Table
{{!}}+ {{VIServerGetClassName|{{{1}}}}} Properties Table
Line 37: Line 38:
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>19</td><td>[[Application class/Application.Directory Path property{{!}}Application:Directory Path]]</td><td>Absolute path to the directory where the application is located.</td><td>Read Only</td><td>Yes (Read Only)</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>19</td><td>[[Application class/Application.Directory Path property{{!}}Application:Directory Path]]</td><td>Absolute path to the directory where the application is located.</td><td>Read Only</td><td>Yes (Read Only)</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1A</td><td>[[Application class/Server.VI Access List property{{!}}Server:VI Access List]]</td><td>List that describes which VIs on the VI server are accessible by remote clients.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1A</td><td>[[Application class/Server.VI Access List property{{!}}Server:VI Access List]]</td><td>List that describes which VIs on the VI server are accessible by remote clients.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1B</td><td>[[Application class/Server.TCP/IP Access List property{{!}}Server:TCP/IP Access List]]</td><td>List that describes which TCP/IP addresses of remote clients may access the VI server.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1B</td><td>[[Application class/Server.TCP-IP Access List property{{!}}Server:TCP/IP Access List]]</td><td>List that describes which TCP/IP addresses of remote clients may access the VI server.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1C</td><td>[[Application class/Application.All VIs In Memory property{{!}}Application:All VIs In Memory]]</td><td>Returns a list of VIs in memory for the specified [[application instance]]. This property returns an error if you wire a remote application reference to the '''reference''' input. For a remote application, use the [[Exported VIs in Memory]] property to return a list of exported VIs.</td><td>Read Only</td><td>Yes (Read Only)</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1C</td><td>[[Application class/Application.All VIs In Memory property{{!}}Application:All VIs In Memory]]</td><td>Returns a list of VIs in memory for the specified [[application instance]]. This property returns an error if you wire a remote application reference to the '''reference''' input. For a remote application, use the [[Exported VIs in Memory]] property to return a list of exported VIs.</td><td>Read Only</td><td>Yes (Read Only)</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#CCFFFF;"><td>1D</td><td>[[Application class/Application.Menu Launch.VI property{{!}}Application:Menu Launch:VI]]</td><td>Returns the name of the VI that launched the calling VI from a menu selection.</td><td>Read Only</td><td>Yes (Read Only)</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#CCFFFF;"><td>1D</td><td>[[Application class/Application.Menu Launch.VI property{{!}}Application:Menu Launch:VI]]</td><td>Returns the name of the VI that launched the calling VI from a menu selection.</td><td>Read Only</td><td>Yes (Read Only)</td></tr>
Line 61: Line 62:
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>32</td><td>[[Application class/Web Server.Logging Enabled property{{!}}Web Server:Logging Enabled]]</td><td>Determines whether the built-in Web Server logs to a file information about HTTP requests.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>32</td><td>[[Application class/Web Server.Logging Enabled property{{!}}Web Server:Logging Enabled]]</td><td>Determines whether the built-in Web Server logs to a file information about HTTP requests.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>33</td><td>[[Application class/Web Server.Logging File Path property{{!}}Web Server:Logging File Path]]</td><td>Determines where the built-in Web Server places the log file.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>33</td><td>[[Application class/Web Server.Logging File Path property{{!}}Web Server:Logging File Path]]</td><td>Determines where the built-in Web Server places the log file.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>34</td><td>[[Application class/Web Server.TCP/IP Access List property{{!}}Web Server:TCP/IP Access List]]</td><td>Sets or gets the TCP/IP addresses that have access to the Web Server. This property also sets or gets whether each address has access to view a VI remotely, view and control a VI remotely, or does not have access to the Web Server.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>34</td><td>[[Application class/Web Server.TCP/IP Access List property{{!}}Web Server:TCP-IP Access List]]</td><td>Sets or gets the TCP/IP addresses that have access to the Web Server. This property also sets or gets whether each address has access to view a VI remotely, view and control a VI remotely, or does not have access to the Web Server.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>35</td><td>[[Application class/Web Server.VI Access List property{{!}}Web Server:VI Access List]]</td><td>Sets or gets the VIs that are visible through the Web Server. This property also sets or gets whether LabVIEW allows access to each VI.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>35</td><td>[[Application class/Web Server.VI Access List property{{!}}Web Server:VI Access List]]</td><td>Sets or gets the VIs that are visible through the Web Server. This property also sets or gets whether LabVIEW allows access to each VI.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>36</td><td>[[Application class/Application.Parent Window For Dialogs property{{!}}Application:Parent Window For Dialogs]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>36</td><td>[[Application class/Application.Parent Window For Dialogs property{{!}}Application:Parent Window For Dialogs]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
Line 152: Line 153:
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>97</td><td>[[Application class/Application.On Line property{{!}}Application:On Line]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>97</td><td>[[Application class/Application.On Line property{{!}}Application:On Line]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>98</td><td>[[Application class/Debug Server.Server Active property{{!}}Debug Server:Server Active]]</td><td>Determines whether the Debug Server is enabled. You can use this property only in LabVIEW-built applications or shared libraries.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>98</td><td>[[Application class/Debug Server.Server Active property{{!}}Debug Server:Server Active]]</td><td>Determines whether the Debug Server is enabled. You can use this property only in LabVIEW-built applications or shared libraries.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>99</td><td>[[Application class/Debug Server.TCP/IP Access List property{{!}}Debug Server:TCP/IP Access List]]</td><td>List that describes which TCP/IP addresses of remote clients can access the Debug Server. You can use this property only in LabVIEW-built applications or shared libraries.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>99</td><td>[[Application class/Debug Server.TCP/IP Access List property{{!}}Debug Server:TCP-IP Access List]]</td><td>List that describes which TCP/IP addresses of remote clients can access the Debug Server. You can use this property only in LabVIEW-built applications or shared libraries.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>9B</td><td>[[Application class/Source Control.Include VILib In Get Dependents property{{!}}Source Control:Include VILib In Get Dependents]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>9B</td><td>[[Application class/Source Control.Include VILib In Get Dependents property{{!}}Source Control:Include VILib In Get Dependents]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>9C</td><td>[[Application class/Source Control.Include InstrLib In Get Dependents property{{!}}Source Control:Include InstrLib In Get Dependents]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>9C</td><td>[[Application class/Source Control.Include InstrLib In Get Dependents property{{!}}Source Control:Include InstrLib In Get Dependents]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
Line 718: Line 719:
|}}{{#ifeq: {{{1|}}} | 43 | <tr style="background-color:#FFFFCC;"><td>633140B</td><td>[[ColorGraphScale class/Unit Label property{{!}}Unit Label]]</td><td>Reference to the unit label of a front panel control. You can use this reference with the [[Text properties]].</td><td>Read Only</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 43 | <tr style="background-color:#FFFFCC;"><td>633140B</td><td>[[ColorGraphScale class/Unit Label property{{!}}Unit Label]]</td><td>Reference to the unit label of a front panel control. You can use this reference with the [[Text properties]].</td><td>Read Only</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>6332000</td><td>[[Control class/Visible property{{!}}Visible]]</td><td>Displays the front panel control.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>6332000</td><td>[[Control class/Visible property{{!}}Visible]]</td><td>Displays the front panel control.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFAAAA;"><td>6332001</td><td>[[Control class/Disabled property{{!}}Disabled]]</td><td></td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFAAAA;"><td>6332001</td><td>[[Control class/Disabled (U8) property{{!}}Disabled]]</td><td>Indicates whether you can operate the control.</td><td>Read/Write</td><td>Yes</td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>6332002</td><td>[[Control class/Key Focus property{{!}}Key Focus]]</td><td>If TRUE, the control has key focus and receives the keys pressed on the keyboard.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>6332002</td><td>[[Control class/Key Focus property{{!}}Key Focus]]</td><td>If TRUE, the control has key focus and receives the keys pressed on the keyboard.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>6332003</td><td>[[Control class/Blinking property{{!}}Blinking]]</td><td>If TRUE, the control blinks.</td><td>Read/Write</td><td>Yes </td></tr>
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>6332003</td><td>[[Control class/Blinking property{{!}}Blinking]]</td><td>If TRUE, the control blinks.</td><td>Read/Write</td><td>Yes </td></tr>
Line 2,667: Line 2,668:
|}}{{#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></div>}}</includeonly>
<noinclude>
<noinclude>


Line 2,730: Line 2,731:
*[[Template:VIServerLegend]]
*[[Template:VIServerLegend]]


 
[[Category:Templates]]
</noinclude>
</noinclude>

Latest revision as of 14:32, 8 May 2020


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