Template:VIServerPropsTable: Difference between revisions
Added all deprecated properties I could discover in LabVIEW 2019 |
Adjusted max height |
||
| (18 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{{#ifeq: {{{1 | <includeonly>{{#ifeq: {{VIServerHasProperties|{{{1}}}}} | FALSE | ''{{#if: {{VIServerGetParent|{{{1}}}}} | This class has no properties or it inherits properties from its parent: [[{{VIServerGetClassName|{{VIServerGetParent|{{{1}}}}}}} class#Properties|{{VIServerGetClassName|{{VIServerGetParent|{{{1}}}}}}} Class]].'' |This class has no properties.}} |<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}} | ||
<div style="width: 80%; max-height: 50em; overflow: auto;"> | |||
{{{!}} class="wikitable sortable" | {{{!}} class="wikitable sortable" | ||
{{!}}+ {{VIServerGetClassName|{{{1}}}}} Properties Table | {{!}}+ {{VIServerGetClassName|{{{1}}}}} Properties Table | ||
| Line 11: | Line 11: | ||
! RTE | ! RTE | ||
{{!}}- | {{!}}- | ||
{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>0</td><td>[[Application class/Application.Name property{{!}}Application:Name]]</td><td>Filename of the application.</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>1</td><td>[[Application class/Application.User Name property{{!}}Application:User Name]]</td><td>User name used to open the application.</td><td>Read/Write</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>2</td><td>[[Application class/Application.Version Number property{{!}}Application:Version Number]]</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>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>3</td><td>[[Application class/Application.Kind property{{!}}Application:Kind]]</td><td>Indicates the LabVIEW instance the VI is running in, including invalid application types.</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>4</td><td>[[Application class/Application.Target.Operating System property{{!}}Application:Target:Operating System]]</td><td>Indicates the operating system for which the application was built. Mac OS refers to Mac OS versions 9 and 8. Carbon refers to Mac OS X (32-bit).</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>5</td><td>[[Application class/Application.Target.CPU property{{!}}Application:Target:CPU]]</td><td>Indicates the target CPU of an application.</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>6</td><td>[[Application class/Operating System.Name property{{!}}Operating System:Name]]</td><td>Name of the operating system where the application is actually running.</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>7</td><td>[[Application class/Operating System.Version Number property{{!}}Operating System:Version Number]]</td><td>Version number of the actual operating system.</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>8</td><td>[[Application class/Application.Exported VIs In Memory property{{!}}Application:Exported VIs In Memory]]</td><td>Returns a list of exported VIs in memory.</td><td>Read Only</td><td>Yes (Read Only)</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>9</td><td>[[Application class/Printing.File Wrap Text Length property{{!}}Printing:File Wrap Text Length]]</td><td>Maximum number of characters on a single line in a file. Affects the [[Print:VI To HTML]], [[Print:VI To RTF]], and [[Print:VI To Text]] methods. Set this property to 0 to print all the characters on one line so the text does not wrap.</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>A</td><td>[[Application class/Printing.PNG Compression Level property{{!}}Printing:PNG Compression Level]]</td><td>Number between 0 and 9 that specifies the level of compression you want for the PNG file for graphics in VIs printed either interactively or with the [[Print:VI To HTML]] method. The quality of the graphic is not affected by the compression, but the graphic file size and speed of compression are affected by this value. Valid values range from 0 to 9 and balance file compression with speed. 0 designates no compression. 1 designates less compression, but faster speed. 9 designates high compression, but slower speed. If you enter –1, LabVIEW selects the best combination of speed and compression.</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>B</td><td>[[Application class/Printing.JPEG Quality property{{!}}Printing:JPEG Quality]]</td><td>Percentage value from 0 to 100 specifying the level of quality you want for the JPEG graphic in VIs printed either interactively or with the [[Print:VI To HTML]] method. The scale balances image quality and file size. A value in the 75 to 95 range produces a compressed file with a high-quality image, and a value below 50 produces a smaller file size with a low-quality image. The default is 80.</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>C</td><td>[[Application class/Printing.Custom Connector? property{{!}}Printing:Custom Connector?]]</td><td>Specifies whether to print the connector pane and icon of VIs when using the custom format with one of the print documentation [[VI class#Methods|VI methods]].</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>D</td><td>[[Application class/Printing.Custom Description? property{{!}}Printing:Custom Description?]]</td><td>Specifies whether to print VI descriptions when using the custom format with one of the print documentation [[VI class#Methods|VI methods]].</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>E</td><td>[[Application class/Printing.Custom Panel? property{{!}}Printing:Custom Panel?]]</td><td>Specifies whether to print the front panel when using the custom format with one of the print documentation [[VI class#Methods|VI methods]].</td><td>Read/Write</td><td>No</td></tr> | |||
| | |||
Setting the sort key to a non-negative number effectively moves that property to the top of the properties list and leaves the other properties unchanged. Setting the sort key to -1 effectively sorts the property normally among other properties that are sorted normally. | Setting the sort key to a non-negative number effectively moves that property to the top of the properties list and leaves the other properties unchanged. Setting the sort key to -1 effectively sorts the property normally among other properties that are sorted normally. | ||
Properties are always sorted within their class.</td><td>Read/Write</td><td>No</td></tr> | Properties are always sorted within their class.</td><td>Read/Write</td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 16539 | <tr style="background-color:#CCFFFF;"><td>46A34800</td><td>[[DataValRefNumConstant class/Is External property{{!}}Is External]]</td><td>Gets or sets whether the data value reference is an [[external data value reference]]. You also can change a data value reference to an external data value reference by right-clicking the data value reference and selecting '''External''' from the shortcut menu.</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 93 | <tr style="background-color:#D1BB80;"><td>46E29C00</td><td>[[Provider class/Owning Project property{{!}}Owning Project]]</td><td></td><td>Read Only</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 93 | <tr style="background-color:#D1BB80;"><td>46E29C01</td><td>[[Provider class/Name property{{!}}Name]]</td><td></td><td>Read Only</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 71 | <tr style="background-color:#D1BB80;"><td>47814000</td><td>[[PlugInDDODummyContainer class/Dummy property{{!}}Dummy]]</td><td></td><td>Read/Write</td><td>Yes</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 16465 | <tr style="background-color:#CCFFFF;"><td>4C59D000</td><td>[[StaticVIReference class/VI Name property{{!}}VI Name]]</td><td>Sets or returns the name of the VI that the [[Static VI Reference]] function references.</td><td>Read/Write</td><td>No</td></tr> | |||
|}}{{#ifeq: {{{1|}}} | 16465 | <tr style="background-color:#CCFFFF;"><td>4C59D001</td><td>[[StaticVIReference class/VI Path property{{!}}VI Path]]</td><td>Sets or returns the path to the VI that the [[Static VI | |||
|}} | |}} | ||
{{!}}} | {{!}}}</div></div>}}</includeonly> | ||
</div> | |||
}} | |||
</includeonly> | |||
<noinclude> | <noinclude> | ||
== Usage == | == Usage == | ||
{{TOCright}} | |||
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=== | |||
<code><nowiki>{{VIServerPropsTable|{{{1}}}}}</nowiki></code> | |||
'''where:''' | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 2,685: | Line 2,687: | ||
| <code>{{{1}}}</code> | | <code>{{{1}}}</code> | ||
| The class ID. | | The class ID. | ||
| <code>Blank - Translates into message: '' | | <code>Blank - Translates into message: ''This class has no properties.''</code> | ||
|} | |} | ||
'' | ===Example: ''No Properties Exists''=== | ||
No properties exist for the [[{{VIServerGetClassName|10}} class|{{VIServerGetClassName|10}} Class]]. | |||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerPropsTable}} | {{VIServerPropsTable|10}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
{{VIServerPropsTable}} | ====Results==== | ||
{{VIServerPropsTable|10}} | |||
'' | ===Example: ''Properties Exist''=== | ||
Properties exist for the [[{{VIServerGetClassName|3}} class|{{VIServerGetClassName|4}} Class]]. | |||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerPropsTable| | {{VIServerPropsTable|3}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
====Results==== | |||
{{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> | ||
====Results==== | |||
{{VIServerPropsTable}} | |||
== See Also == | |||
*[[Template:VIServerEventsTable]] | |||
*[[Template:VIServerMethodsTable]] | |||
*[[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/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}}
Results
This class has no properties.