Template:VIServerMethodsTable: Difference between revisions
Appearance
Created full Methods lookup table |
Adding max height and scrollbars to Methods tables |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{{#ifeq: {{{1 | <includeonly>{{#ifeq: {{VIServerHasMethods|{{{1}}}}} | FALSE | ''{{#if: {{VIServerGetParent|{{{1}}}}} | This class has no methods or it inherits methods from its parent: [[{{VIServerGetClassName|{{VIServerGetParent|{{{1}}}}}}} class#Methods|{{VIServerGetClassName|{{VIServerGetParent|{{{1}}}}}}} Class]]. | This class has no methods.}}'' |<span class="mw-customtoggle-methodstable">Show/Hide {{VIServerGetClassName|{{{1}}}}} Properties Table</span> | ||
<span class="mw-customtoggle-methodstable">Show/Hide {{VIServerGetClassName|{{{1}}}}} Properties Table</span> | |||
<div class="mw-collapsible" id="mw-customcollapsible-methodstable"> | <div class="mw-collapsible" id="mw-customcollapsible-methodstable"> | ||
{{VIServerLegend|showrte=TRUE}} | {{VIServerLegend|showrte=TRUE}} | ||
<div style="width: 80%; max-height: 50em; overflow: auto;"> | |||
{{{!}} class="wikitable sortable" | {{{!}} class="wikitable sortable" | ||
{{!}}+ {{VIServerGetClassName|{{{1}}}}} Methods Table | {{!}}+ {{VIServerGetClassName|{{{1}}}}} Methods Table | ||
| Line 19: | Line 19: | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3EF</td><td>[[VI class/Print.VI To RTF method{{!}}Print:VI To RTF]]</td><td>Saves the VI information to an RTF file.</td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3EF</td><td>[[VI class/Print.VI To RTF method{{!}}Print:VI To RTF]]</td><td>Saves the VI information to an RTF file.</td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3F0</td><td>[[VI class/Print.VI To Text method{{!}}Print:VI To Text]]</td><td>Saves the VI information to a text file. You cannot save the icon, connector pane, front panel, block diagram, subVI icons, and VI hierarchy to text.</td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3F0</td><td>[[VI class/Print.VI To Text method{{!}}Print:VI To Text]]</td><td>Saves the VI information to a text file. You cannot save the icon, connector pane, front panel, block diagram, subVI icons, and VI hierarchy to text.</td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFAAAA;"><td>3F1</td><td>[[VI class/Control Value.Set | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFAAAA;"><td>3F1</td><td>[[VI class/Control Value.Set (Flattened) (Deprecated) method{{!}}Control Value:Set [Flattened] (Deprecated)]]</td><td></td><td>Yes</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFAAAA;"><td>3F2</td><td>[[VI class/Control Value.Get | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFAAAA;"><td>3F2</td><td>[[VI class/Control Value.Get (Flattened) (Deprecated) method{{!}}Control Value:Get [Flattened] (Deprecated)]]</td><td></td><td>Yes</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3F3</td><td>[[VI class/Default Values.Make Current Default method{{!}}Default Values:Make Current Default]]</td><td>Changes the defaults of all controls on the front panel to be the current values. This method is available only in edit mode.</td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3F3</td><td>[[VI class/Default Values.Make Current Default method{{!}}Default Values:Make Current Default]]</td><td>Changes the defaults of all controls on the front panel to be the current values. This method is available only in edit mode.</td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3F4</td><td>[[VI class/Default Values.Reinitialize All To Default method{{!}}Default Values:Reinitialize All To Default]]</td><td>Changes the current values of all controls on the front panel to their defaults.</td><td>Yes (Read/Write)</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3F4</td><td>[[VI class/Default Values.Reinitialize All To Default method{{!}}Default Values:Reinitialize All To Default]]</td><td>Changes the current values of all controls on the front panel to their defaults.</td><td>Yes (Read/Write)</td></tr> | ||
| Line 26: | Line 26: | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FA</td><td>[[VI class/Revert VI method{{!}}Revert VI]]</td><td>Discards changes and reloads a VI from disk.</td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FA</td><td>[[VI class/Revert VI method{{!}}Revert VI]]</td><td>Discards changes and reloads a VI from disk.</td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FB</td><td>[[VI class/Print.Panel To Printer method{{!}}Print:Panel To Printer]]</td><td>Prints just the front panel to the current printer. You cannot use this method to print a block diagram, list of controls, or polymorphic VI front panel.</td><td>Yes (Read/Write)</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FB</td><td>[[VI class/Print.Panel To Printer method{{!}}Print:Panel To Printer]]</td><td>Prints just the front panel to the current printer. You cannot use this method to print a block diagram, list of controls, or polymorphic VI front panel.</td><td>Yes (Read/Write)</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFAAAA;"><td>3FC</td><td>[[VI class/Control Value.Get All | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFAAAA;"><td>3FC</td><td>[[VI class/Control Value.Get All (Flattened) (Deprecated) method{{!}}Control Value:Get All [Flattened] (Deprecated)]]</td><td></td><td>Yes</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FD</td><td>[[VI class/Lock State.Get method{{!}}Lock State:Get]]</td><td>Returns the lock state of the VI and indicates whether the password for the VI is in the password cache.</td><td>Yes (Read/Write)</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FD</td><td>[[VI class/Lock State.Get method{{!}}Lock State:Get]]</td><td>Returns the lock state of the VI and indicates whether the password for the VI is in the password cache.</td><td>Yes (Read/Write)</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FE</td><td>[[VI class/Lock State.Set method{{!}}Lock State:Set]]</td><td>[[Sets the lock state]] of a VI. If '''interactive''' is FALSE (default), you can use '''password''' to either unlock a password-protected VI or [[set the password]] of an unprotected VI. If '''interactive''' is TRUE, LabVIEW ignores '''password''' and displays a dialog box that prompts you to change the lock state.</td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>3FE</td><td>[[VI class/Lock State.Set method{{!}}Lock State:Set]]</td><td>[[Sets the lock state]] of a VI. If '''interactive''' is FALSE (default), you can use '''password''' to either unlock a password-protected VI or [[set the password]] of an unprotected VI. If '''interactive''' is TRUE, LabVIEW ignores '''password''' and displays a dialog box that prompts you to change the lock state.</td><td>No</td></tr> | ||
| Line 290: | Line 290: | ||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>840</td><td>[[Application class/Global Data.Get method{{!}}Global Data:Get]]</td><td></td><td>Yes</td></tr> | |}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>840</td><td>[[Application class/Global Data.Get method{{!}}Global Data:Get]]</td><td></td><td>Yes</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>841</td><td>[[Application class/Global Data.Free method{{!}}Global Data:Free]]</td><td></td><td>Yes</td></tr> | |}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>841</td><td>[[Application class/Global Data.Free method{{!}}Global Data:Free]]</td><td></td><td>Yes</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFAAAA;"><td>842</td><td>[[Application class/Linker.Old Read Info From File method{{!}}Linker:Old Read Info From File]]</td><td></td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFAAAA;"><td>842</td><td>[[Application class/Linker.Old Read Info From File method (Deprecated){{!}}Linker:Old Read Info From File]]</td><td></td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>843</td><td>[[Application class/Linker.Write Info To File method{{!}}Linker:Write Info To File]]</td><td></td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#D1BB80;"><td>843</td><td>[[Application class/Linker.Write Info To File method{{!}}Linker:Write Info To File]]</td><td></td><td>No</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>844</td><td>[[Application class/Debug Connection.Open Debug Connection method{{!}}Debug Connection:Open Debug Connection]]</td><td>Opens a connection to the application or shared library you can debug.</td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 1 | <tr style="background-color:#FFFFCC;"><td>844</td><td>[[Application class/Debug Connection.Open Debug Connection method{{!}}Debug Connection:Open Debug Connection]]</td><td>Opens a connection to the application or shared library you can debug.</td><td>No</td></tr> | ||
| Line 1,248: | Line 1,248: | ||
|}}{{#ifeq: {{{1|}}} | 94 | <tr style="background-color:#D1BB80;"><td>7F2BE007</td><td>[[CopyOperation class/Find Item method{{!}}Find Item]]</td><td></td><td>No</td></tr> | |}}{{#ifeq: {{{1|}}} | 94 | <tr style="background-color:#D1BB80;"><td>7F2BE007</td><td>[[CopyOperation class/Find Item method{{!}}Find Item]]</td><td></td><td>No</td></tr> | ||
|}} | |}} | ||
{{!}}} | {{!}}}</div></div>}}</includeonly> | ||
</div> | |||
}} | |||
</includeonly> | |||
<noinclude> | <noinclude> | ||
== Usage == | == Usage == | ||
{{TOCright}} | |||
This template contains a lookup table for all of the methods. It is used in the [[VI Server Class Hierarchy]] class pages to display the methods tables. The parameter is the Class ID number where the list is then filtered to methods of that class if it has any. If the parameter is left blank, the default is that it has no methods. | |||
===Syntax=== | |||
<code><nowiki>{{VIServerMethodsTable|{{{1}}}}}</nowiki></code> | |||
'''where:''' | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 1,265: | Line 1,267: | ||
| <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 methods.''</code> | ||
|} | |} | ||
'' | ===Example: ''No Methods Exists''=== | ||
No methods exist for the [[{{VIServerGetClassName|10}} class|{{VIServerGetClassName|10}} Class]]. | |||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerMethodsTable}} | {{VIServerMethodsTable|10}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
{{VIServerMethodsTable}} | ====Results==== | ||
{{VIServerMethodsTable|10}} | |||
'' | ===Example: ''Methods Exist''=== | ||
Methods exist for the [[{{VIServerGetClassName|6}} class|{{VIServerGetClassName|6}} Class]]. | |||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerMethodsTable| | {{VIServerMethodsTable|6}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
====Results==== | |||
{{VIServerMethodsTable|6}} | |||
===Example: ''Passing a null value''=== | |||
Passing a null value defaults to no methods. | |||
<code> | <code> | ||
<nowiki> | <nowiki> | ||
{{VIServerMethodsTable | {{VIServerMethodsTable}} | ||
</nowiki> | </nowiki> | ||
</code> | </code> | ||
====Results==== | |||
{{VIServerMethodsTable}} | |||
== See Also == | |||
*[[Template:VIServerEventsTable]] | |||
*[[Template:VIServerPropsTable]] | |||
*[[Template:VIServerLegend]] | |||
[[Category:Templates]] | |||
</noinclude> | </noinclude> | ||
Latest revision as of 14:34, 8 May 2020
Usage
This template contains a lookup table for all of the methods. It is used in the VI Server Class Hierarchy class pages to display the methods tables. The parameter is the Class ID number where the list is then filtered to methods of that class if it has any. If the parameter is left blank, the default is that it has no methods.
Syntax
{{VIServerMethodsTable|{{{1}}}}}
where:
| Parameter | Description | Default |
|---|---|---|
{{{1}}}
|
The class ID. | Blank - Translates into message: This class has no methods.
|
Example: No Methods Exists
No methods exist for the LVVariant Class.
{{VIServerMethodsTable|10}}
Results
This class has no methods or it inherits methods from its parent: Control Class.
Example: Methods Exist
Methods exist for the Control Class.
{{VIServerMethodsTable|6}}
Results
Show/Hide Control Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 6331C00 | Reinitialize To Default | Reinitializes the value of the control to the default value. | Yes (Read/Write) |
| 6331C01 | Create:Control Reference | Creates a control reference for the control and returns a reference to it. | No |
| 6331C02 | Create:Local Variable | Creates a local variable for the control and returns a reference to it. | No |
| 6331C03 | Create:Property Node | Creates a Property Node for the control and returns a reference to it. | No |
| 6331C04 | Create:Invoke Node | Creates an Invoke Node for the control and returns a reference to it. | No |
| 6331C05 | Old Get Image | Yes | |
| 6331C06 | Attach DataSocket | National Instruments recommends using front panel data binding through the Shared Variable Engine or using the Bind To Network Path method to attach a data connection to a control. | Yes (Read/Write) |
| 6331C07 | Remove DataSocket | Removes an opc, ftp, and http connection from a control on Windows, and a dstp and file connection from a control on all LabVIEW-supported platforms. | Yes (Read/Write) |
| 6331C08 | Copy Wizard Template | No | |
| 6331C09 | Disconnect From Typedef | Disconnects the control from the type definition and returns TRUE. If the control is not connected to a type definition, LabVIEW returns FALSE. | No |
| 6331C0A | Update From Typedef | Updates the control from the type definition and returns TRUE. If the control is not connected to a type definition, LabVIEW returns FALSE. | No |
| 6331C0B | Old Get FP Term Image | Yes | |
| 6331C0C | Get Image | Returns an image of a front panel object. | Yes (Read/Write) |
| 6331C0D | Get Terminal Image | Returns an image of the block diagram terminal of a front panel object. | Yes (Read/Write) |
| 6331C0E | Start Drag | Starts a drag and drop operation using the specified control as the source. | Yes (Read/Write) |
| 6331C0F | Data Binding:Bind To Network Path | Binds a control to an NI Publish-Subscribe Protocol (NI-PSP) network path. You can add new connections only at edit time. | Yes (Read/Write) |
| 6331C11 | Data Binding:Bind To Network Variable | Yes | |
| 6331C12 | Data Binding:Unbind | Unbinds a control from an NI Publish-Subscribe Protocol (NI-PSP) network path. | Yes (Read/Write) |
| 6331C13 | Fit Control To Pane | Resizes the control to the size of the pane that contains it and sets the control to scale with the pane. | Yes (Read/Write) |
| 6331C14 | Data Operations:Copy Data | Copies data from the control to the clipboard. | Yes (Read/Write) |
| 6331C15 | Data Operations:Paste Data | Pastes data from the clipboard to the control. | Yes (Read/Write) |
| 6331C16 | Stub:Convert To Stub | No | |
| 6331C17 | Stub:Revert From Stub | No |
Example: Passing a null value
Passing a null value defaults to no methods.
{{VIServerMethodsTable}}
Results
This class has no methods.