Jump to content

Template:VIServerMethodsTable: Difference between revisions

From LabVIEW Wiki
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}}}}} Methods 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}}
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 [Flattened] (Deprecated) method{{!}}Control Value:Set [Flattened] (Deprecated)]]</td><td></td><td>Yes</td></tr>
|}}{{#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 [Flattened] (Deprecated) method{{!}}Control Value:Get [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 (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 [Flattened] (Deprecated) method{{!}}Control Value:Get All [Flattened] (Deprecated)]]</td><td></td><td>Yes</td></tr>
|}}{{#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


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
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Generic Methods Table
Method ID Long Name (English) Description RTE
6327400DeleteDeletes the object. After LabVIEW deletes the object, all references to the object are invalid.Yes (Read/Write)
6327401Tag:Set TagSets a tag value. Returns FALSE if LabVIEW does not set the tag value.Yes (Read/Write)
6327402Tag:Remove TagRemoves the specified tag. Returns FALSE if LabVIEW did not remove the tag.Yes (Read/Write)
6327403Tag:Get TagReturns a tag value associated with the tag. Returns FALSE if the tag does not exist.Yes (Read/Write)
6327404Tag:Set Tag PersistenceSets the persistence of the tag. Returns FALSE if not found.Yes (Read/Write)
6327405Class Operator:CallCalls 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)
6327406Class Operator:TraverseTraverses 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)
6327407Set PropertyYes
6327408Get PropertyYes
6327409Get Property Call DataYes
632740ANI Security:Set Access Control ListYes
632740BNI Security:Get Access Control ListYes
632740CNI Security:Remove Access Control ListYes
632740DSet HeapDocMod For ObjectNo



Example: Methods Exist - GObject Class

{{VIServerMethodsTable|36}}


Show/Hide GObject Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GObject Methods Table
Method ID Long Name (English) Description RTE
632A400MoveMoves the object to the specified position.No
632A401Object HighlightGiven a Gobject Reference, this method scrolls to and highlights the object.Yes (Read/Write)
632A402ReplaceReplaces 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
632A403Replace No AttributesReplaces 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
632A404Launch Config PageNo
632A405InvalidateYes
632A406Replace Preferring Stub DDO OnFPNo
632A407Get Help InfoReturns the help information for the object.Yes (Read/Write)



Example: Methods Exist - LVClassLibrary Class

{{VIServerPropsTable|85}}


Show/Hide LVClassLibrary Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
LVClassLibrary Properties Table
Property ID Long Name (English) Description R/W RTE
97D7002Simple NameReturns the name of the class without prepending namespace information from owning classes.Read OnlyNo
97D7003Parent ClassGets or sets the LabVIEW class from which the referenced class directly inherits.Read/WriteNo
97D7004Children 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 OnlyNo
97D7005PropertiesRead OnlyYes
97D7006Dynamic Member VIsRead OnlyYes
97D7007Static Member VIsRead OnlyYes
97D7009Name Visible In ProbeRead/WriteYes
97D700AWire PensGets or sets the appearance of the wire associated with this LabVIEW class.Read/WriteNo
97D700BDefault InstanceRead OnlyNo
97D700DProbesRead OnlyYes
97D700EModification DateRead OnlyYes
97D700FPrivate Data ControlReturns a reference to the control that contains the private data of this LabVIEW class.Read OnlyNo
97D7010DefaultProbeReturns 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/WriteNo
97D7011Transfer 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/WriteNo
97D7012Self References RestrictedProperty indicates that data value references to this class can only be created/deleted by member VIs of this class.Read/WriteNo
97D7013Child References RestrictedProperty indicates whether data value references to all of this class descendants can be created only in member VIs of this class.Read/WriteNo
97D7014Ancestor Restricts Reference CreationProperty 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 OnlyNo
97D7015Dynamic 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 OnlyNo
97D7016Static 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 OnlyNo