Template:VIServerClassTables
Usage
Use this template is for VI Server Class Hierarchy class pages.
Syntax is as follows:
{{VIServerClassTables|{{{1}}}}}
where:
| Parameter | Description | Default |
|---|---|---|
{{{1}}}
|
The Class ID of a class in the VI Server Class Hierarchy. | Error. No class ID specified.
|
Example: Control class - Has Properties, Methods, and Events
{{VIServerClassTables|6}}
Result:
Properties
Show/Hide Control 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 |
|---|---|---|---|---|
| 6332000 | Visible | Displays the front panel control. | Read/Write | Yes |
| 6332001 | Disabled | Indicates whether you can operate the control. | Read/Write | Yes |
| 6332002 | Key Focus | If TRUE, the control has key focus and receives the keys pressed on the keyboard. | Read/Write | Yes |
| 6332003 | Blinking | If TRUE, the control blinks. | Read/Write | Yes |
| 6332004 | Caption | Reference to the caption object. You can use this reference with the Text properties. | Read Only | Yes |
| 6332005 | Label | Reference to the label object. | Read Only | Yes |
| 6332006 | Terminal | Returns the reference to the block diagram terminal of this control. Use this property to navigate between the front panel and the block diagram of a VI. | Read Only | No |
| 6332007 | Indicator | If TRUE, the front panel object is an indicator. If FALSE, the object is a control. | Read/Write | Yes (Read Only) |
| 6332008 | Synchronous Display | When TRUE, enables synchronous display that shows every update to a data value in a control or indicator. When FALSE, asynchronous display permits the execution system to reduce updates to a slower rate and spend more time executing VIs. | Read/Write | Yes (Read Only) |
| 6332009 | Control Reference Nodes[] | Returns references to the control reference nodes of this control. | Read Only | No |
| 633200A | Local Variables[] | Returns references to the local variables of this control. | Read Only | No |
| 633200B | Property Nodes[] | Returns references to the property nodes of this control. | Read Only | No |
| 633200C | Invoke Nodes[] | Returns references to the invoke nodes of this control. | Read Only | No |
| 633200D | Value | Data value of the control (LV variant). If this is a Boolean value configured with a latching mechanical action, this property always returns an error. Due to race conditions that can occur when you have a Boolean value with latching mechanical action, you cannot programmatically read Boolean values that are set with a latching mechanical action. | Read/Write | Yes |
| 633200E | Default Value | Default value of the control (LabVIEW variant). | Read/Write | Yes (Read Only) |
| 633200F | Description | Description of the front panel object that appears in the Context Help window when you move the cursor over the object and in VI documentation you generate. | Read/Write | Yes |
| 6332010 | Focus Key Binding | Sets a shortcut key to navigate to this control. | Read/Write | Yes |
| 6332011 | Type Descriptor | Read Only | Yes | |
| 6332014 | Tip Strip | Sets or returns the tip strip of a control. A tip strip is the brief description of the object that appears when you move the cursor over the object. | Read/Write | Yes |
| 6332015 | DataSocket:URL | Gets or sets the URL to which the control is connected. Valid URLs for using the DataSocket properties to connect controls are the opc, ftp, and http protocols on Windows, and the dstp and file protocols on all LabVIEW-supported platforms. | Read/Write | Yes |
| 6332016 | DataSocket:Mode | Gets or sets the mode of the data connection. | Read/Write | Yes |
| 6332017 | DataSocket:Enabled | This is the enabled state of the opc, ftp, and http connection on Windows, and the dstp and file connection on all LabVIEW-supported platforms. A connection can transfer data only when enabled. | Read/Write | Yes |
| 6332018 | DataSocket:Status | Returns the status of the data connection. The connection status can be Invalid Status, Unconnected, Active, Idle, Error, or Connecting. | Read Only | Yes |
| 6332019 | Wizard Data | Read/Write | Yes | |
| 633201A | Is Typedef? | Returns whether the control is linked to the type definition. | Read Only | Yes (Read Only) |
| 633201B | Typedef:Path | Returns the path to the type definition if the control is linked to a type definition. Otherwise, LabVIEW returns an empty path. | Read Only | Yes (Read Only) |
| 633201C | Auto-Update From Typedef | If TRUE, the control automatically updates when the type definition changes. | Read/Write | Yes |
| 633201D | Bit Accurate Data Size | Read Only | Yes | |
| 633201E | DataSocket:LED Visible | Shows or hides the connection status indicator. | Read/Write | Yes |
| 633201F | Latch Value | Read/Write | Yes | |
| 6332020 | Is On Connector Pane | Returns whether a control or indicator is on the connector pane of a VI. | Read Only | Yes |
| 6332021 | Skip When Tabbing | If TRUE, LabVIEW skips this control when you tab through the front panel. | Read/Write | Yes |
| 6332022 | Has Caption | Returns TRUE if the control has a caption. | Read Only | Yes |
| 6332023 | Value (Signaling) | Sets the value of the control and generates a Value Change event. | Write Only | Yes |
| 6332025 | Typedef:VI | Returns a reference to the type definition if the control is connected to a type definition. Otherwise, LabVIEW returns <NotARef>. | Read Only | No |
| 6332026 | C Type | Read Only | Yes | |
| 6332027 | Type Descriptor (Full) | Read Only | Yes | |
| 6332028 | Data Binding:Path | Reads or writes the NI Publish-Subscribe Protocol (NI-PSP) URL to which the control is connected. To write this property, you must bind the control to the PSP URL before you begin writing. | Read/Write | Yes |
| 6332029 | Data Binding:Mode | Gets or sets the mode of the data connection. | Read/Write | Yes |
| 633202A | Data Binding:Status | Returns the status of the data connection. The connection status can be Invalid Status, Unconnected, Active, Idle, Error, or Connecting. | Read Only | Yes |
| 633202B | Data Binding:LED Visible | Shows or hides the data binding indicator. | Read/Write | Yes |
| 633202C | Data Binding:Persist ID | Read Only | Yes | |
| 633202D | Data Binding:Binding Type | Returns the type of binding. | Read Only | Yes |
| 633202E | Data Binding:Blink On Alarm | Read/Write | Yes | |
| 633202F | Grow Info | Returns the growing abilities for this control. | Read Only | Yes |
| 6332030 | Grow Info:Can Grow Horizontally | Returns if this control can grow horizontally. | Read Only | Yes |
| 6332031 | Grow Info:Can Grow Vertically | Returns if this control can grow vertically. | Read Only | Yes |
| 6332032 | Grow Info:Min Horizontally | Returns the minimum size horizontally this control can grow. | Read Only | Yes |
| 6332033 | Grow Info:Min Vertically | Returns the minimum size vertically this control can grow. | Read Only | Yes |
| 6332034 | Grow Info:Max Horizontally | Returns the maximum size horizontally this control can grow. | Read Only | Yes |
| 6332035 | Grow Info:Max Vertically | Returns the maximum size vertically this control can grow. | Read Only | Yes |
| 6332036 | XControl:Is XControl? | Returns TRUE if the control is an XControl, FALSE otherwise. | Read Only | Yes |
| 6332037 | XControl:Container Bounds | Sets or gets the container bounds of the XControl. | Read/Write | Yes |
| 6332038 | XControl:Container Bounds:Width | Width of the XControl. | Read/Write | Yes |
| 6332039 | XControl:Container Bounds:Height | Height of the XControl. | Read/Write | Yes |
| 633203A | Style ID | Returns the style of the control. | Read Only | Yes |
| 633203B | Is Stub? | Read Only | Yes | |
| 633203C | Genericity | Read/Write | Yes | |
| 633203D | Disabled | Indicates whether you can operate the control. | Read/Write | Yes |
| 633203E | Owning Pane | Returns a reference to the pane that owns the referenced control. | Read Only | Yes |
| 633203F | Built-In Mouse Wheel Support | Sets the conditions under which the control responds to mouse wheel movement. | Read/Write | Yes |
| 6332040 | Control Index | Gets the index of the control or indicator you specify. If the control or indicator for which you want to get the index does not have a terminal on the block diagram, this property returns an error. | Read Only | Yes |
| 6332041 | Value (Undoable) | Write Only | Yes | |
| 6332043 | Default Value (Undoable) | Write Only | No |
Methods
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 |
Events
Show/Hide Control Events Table
| Legend | |
|---|---|
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated |
| Code | Name | Description | Type |
|---|---|---|---|
| 1073741869 | Drag Ended | Generated after a drag and drop operation completes. | Notify |
| 2684354617 | Drag Enter | Generated when there is a drag operation pending and the cursor enters the bounds of a control. | Notify |
| 1073741885 | Drag Leave | Generated when there is a drag operation pending and the mouse leaves a control that can accept a drag, or if a user cancels a drag and drop operation when hovering over a control. | Notify |
| 2684354618 | Drag Over | Generated when there is a drag and drop operation pending, as the mouse moves over a control. | Notify |
| 2684354606 | Drag Source Update | Generated when the mouse moves or a key state changes during a drag and drop operation. | Notify |
| 1073741867 | Drag Starting | ||
| 2147483692 | Drag Starting? | ||
| 2684354622 | Drop | Generated when the user lifts the mouse when hovering over a control when there is a drag and drop operation pending. | Notify |
| 1073741847 | Key Down | Generated on a control that has keyboard focus. If a key press matches a keyboard shortcut in the VI menu, such as Ctrl-C or Ctrl-V, LabVIEW does not generate a Key Down event, regardless of whether the menu item is enabled. Key Down Event Caveats
| Notify |
| 2147483658 | Key Down? | Generated on a control that has keyboard focus. If a key press matches a keyboard shortcut in the VI menu, such as Ctrl-C or Ctrl-V, LabVIEW does not generate a Key Down event, regardless of whether the menu item is enabled. | Filter |
| 1073741848 | Key Repeat | Generated at regular intervals when the user presses and holds a key in a front panel control. | Notify |
| 2147483659 | Key Repeat? | Generated when the user presses and holds a key in a front panel control. | Filter |
| 1073741836 | Key Up | Generated when the user releases a key on the keyboard in a specific control on the front panel. | Notify |
| 1073741842 | Mouse Down | Generated when you click the mouse button on a specific control. | Notify |
| 2147483655 | Mouse Down? | Generated when you click the mouse button on a specific control. | Filter |
| 1073741839 | Mouse Enter | Generated when the cursor enters the bounds of the front panel object. | Notify |
| 1073741838 | Mouse Leave | Generated when the cursor leaves the bounds of the front panel object. | Notify |
| 1073741833 | Mouse Move | Generated when you move the mouse over a control. | Notify |
| 1073741832 | Mouse Up | Generated when you release the mouse button on a specific control. LabVIEW does not generate this event if a shortcut menu appears when you click the mouse button. | Notify |
| 1073741905 | Mouse Wheel | Generated when you scroll the mouse wheel over a control. | Notify |
| 2147483699 | Shortcut Menu Activation? | Generated when the user right-clicks a control to display the shortcut menu. | Filter |
| 1073741892 | Shortcut Menu Dismissed | ||
| 2147483701 | Shortcut Menu Selection? (App) | Generated when the user selects an application item from the shortcut menu. This event is posted before the application item is processed by LabVIEW. | Filter |
| 1073741878 | Shortcut Menu Selection (App) | Generated when the user selects an application item from the shortcut menu of a control. Use the Shortcut Menu Selection (User) event to generate an event when the user selects a user-defined menu item. This event is posted after the built-in shortcut menu item is processed by LabVIEW. | Notify |
| 1073741876 | Shortcut Menu Selection (User) | Generated when the user selects a user-defined item from the shortcut menu. Use the Shortcut Menu Selection (App) event to generate an event when the user selects an application item from the shortcut menu. | Notify |
| 1073741826 | Value Change | Generated when the user changes the value of a control. You must read the terminal of a latched Boolean control in its Value Change event case. | Notify |
Example: LVVariant class - Does not have any Properties, Methods, or Events
{{VIServerClassTables|10}}
Result:
Properties
This class has no properties or it inherits properties from its parent: Control Class.
Methods
This class has no methods or it inherits methods from its parent: Control Class.
Events
This class has no events or it inherits events from its parent: Control Class.
Example: Passing a Null
Passing a NULL results in an error message.
{{VIServerClassTables}}
Result: Error. No class ID specified.