Template:VIServerMethodsTable: Difference between revisions
m Typo |
m Fixed some wiki formatting |
||
| Line 1: | Line 1: | ||
<includeonly>{{#ifeq: {{{1|}}} || ''No Methods for this class.'' | | <includeonly>{{#ifeq: {{{1|}}} || ''No Methods for this class.'' | | ||
<span class="mw-customtoggle-methodstable">Show/Hide {{VIServerGetClassName|{{{1}}}}} | <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}} | ||
| 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> | ||
Revision as of 02:51, 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 methods. It is used in the VI Server Class Hierarchy class pages to display the methods tables. The parameter is either the Class ID number where the list is then filtered to methods of that class, or the parameter is left blank to signify this class has no methods.
| Parameter | Description | Default |
|---|---|---|
{{{1}}}
|
The class ID. | Blank - Translates into message: No Methods for this class.
|
Example: No Methods Exists
{{VIServerMethodsTable}}
No Methods for this class.
Example: Methods Exist - Generic Class
{{VIServerMethodsTable|3}}
Show/Hide Generic Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 6327400 | Delete | Deletes the object. After LabVIEW deletes the object, all references to the object are invalid. | Yes (Read/Write) |
| 6327401 | Tag:Set Tag | Sets a tag value. Returns FALSE if LabVIEW does not set the tag value. | Yes (Read/Write) |
| 6327402 | Tag:Remove Tag | Removes the specified tag. Returns FALSE if LabVIEW did not remove the tag. | Yes (Read/Write) |
| 6327403 | Tag:Get Tag | Returns a tag value associated with the tag. Returns FALSE if the tag does not exist. | Yes (Read/Write) |
| 6327404 | Tag:Set Tag Persistence | Sets the persistence of the tag. Returns FALSE if not found. | Yes (Read/Write) |
| 6327405 | Class Operator:Call | Calls the VI associated with the Operator Name, on the object. Returns FALSE if no operator VI is associated with the class of the object. | Yes (Read/Write) |
| 6327406 | Class Operator:Traverse | Traverses the object tree of a specified object and performs a function on any object that has a process specified. If the traverse fails, LabVIEW returns FALSE. | Yes (Read/Write) |
| 6327407 | Set Property | Yes | |
| 6327408 | Get Property | Yes | |
| 6327409 | Get Property Call Data | Yes | |
| 632740A | NI Security:Set Access Control List | Yes | |
| 632740B | NI Security:Get Access Control List | Yes | |
| 632740C | NI Security:Remove Access Control List | Yes | |
| 632740D | Set HeapDocMod For Object | No |
Example: Methods Exist - GObject Class
{{VIServerMethodsTable|36}}
Show/Hide GObject Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 632A400 | Move | Moves the object to the specified position. | No |
| 632A401 | Object Highlight | Given a Gobject Reference, this method scrolls to and highlights the object. | Yes (Read/Write) |
| 632A402 | Replace | Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: Style, Path, or Palette String. | No |
| 632A403 | Replace No Attributes | Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: Style, Path, or Palette String. This method does not maintain any size or color attributes of the object you replace. | No |
| 632A404 | Launch Config Page | No | |
| 632A405 | Invalidate | Yes | |
| 632A406 | Replace Preferring Stub DDO OnFP | No | |
| 632A407 | Get Help Info | Returns the help information for the object. | Yes (Read/Write) |
Example: Methods Exist - LVClassLibrary Class
{{VIServerPropsTable|85}}
Show/Hide LVClassLibrary 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 |
|---|---|---|---|---|
| 97D7002 | Simple Name | Returns the name of the class without prepending namespace information from owning classes. | Read Only | No |
| 97D7003 | Parent Class | Gets or sets the LabVIEW class from which the referenced class directly inherits. | Read/Write | No |
| 97D7004 | Children In Memory[] | Returns an array of references to all LabVIEW classes in memory that directly inherit from the referenced class. This property does not return additional descendents of the child classes. | Read Only | No |
| 97D7005 | Properties | Read Only | Yes | |
| 97D7006 | Dynamic Member VIs | Read Only | Yes | |
| 97D7007 | Static Member VIs | Read Only | Yes | |
| 97D7009 | Name Visible In Probe | Read/Write | Yes | |
| 97D700A | Wire Pens | Gets or sets the appearance of the wire associated with this LabVIEW class. | Read/Write | No |
| 97D700B | Default Instance | Read Only | No | |
| 97D700D | Probes | Read Only | Yes | |
| 97D700E | Modification Date | Read Only | Yes | |
| 97D700F | Private Data Control | Returns a reference to the control that contains the private data of this LabVIEW class. | Read Only | No |
| 97D7010 | DefaultProbe | Returns a reference to the default probe for the LabVIEW class library. The default probe is the probe LabVIEW uses when you first create a probe from a wire of this class type. | Read/Write | No |
| 97D7011 | Transfer Must Overrides? | Determines whether to allow the class to transfer all override requirements to any descendant classes instead of overriding the dynamic dispatch VI itself. | Read/Write | No |
| 97D7012 | Self References Restricted | Property indicates that data value references to this class can only be created/deleted by member VIs of this class. | Read/Write | No |
| 97D7013 | Child References Restricted | Property indicates whether data value references to all of this class descendants can be created only in member VIs of this class. | Read/Write | No |
| 97D7014 | Ancestor Restricts Reference Creation | Property indicates that an ancestor class controls the creation of data value references to this class. Only the ancestors member VIs can create data value references. | Read Only | No |
| 97D7015 | Dynamic Member VIs[] | Returns an array of references to the member VIs of the referenced LabVIEW class that contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that do not contain a dynamic dispatch terminal, use the Static Member VIs() property. | Read Only | No |
| 97D7016 | Static Member VIs[] | Returns an array of references to the members VIs of the referenced LabVIEW class that do not contain a dynamic dispatch terminal. To obtain references to the methods of the referenced class that contain a dynamic dispatch terminal, use the Dynamic Member VIs() property. | Read Only | No |
