Jump to content

Constant class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Sever Category from page
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=Constant|id=16386|scope=script|class_0=Generic|class_1=GObject|class_2=Constant}}
{{VIServerClass|16386}}


{{stub}}
{{stub}}
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Constant Properties Table</span>
{{VIServerClassTables|16386}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Constant Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|634AC07
| [[Constant class/Auto-Update property|Auto-Update]]
|If TRUE, the constant automatically updates when the type definition changes.
|R/W
|
|- style="background-color:#CCFFFF;"
|634AC01
| [[Constant class/Desc property|Desc]]
|Provides a description of the constant.
|R/W
|
|- style="background-color:#CCFFFF;"
|634AC05
| [[Constant class/Typedef? property|Typedef?]]
|Returns whether the constant is linked to the type definition.
|R
|
|- style="background-color:#CCFFFF;"
|634AC02
| [[Constant class/Label property|Label]]
|Returns a reference to the label.
|R
|
|- style="background-color:#CCFFFF;"
|634AC04
| [[Constant class/Terminal property|Terminal]]
|Returns a reference to the terminal.
|R
|
|- style="background-color:#CCFFFF;"
|634AC03
| [[Constant class/TipStrip property|TipStrip]]
|Gets or sets the tip strip of a constant. A tip strip is the brief description of the object that appears when you move the cursor over the object.
 
Other products refer to tip strips as tooltips.
|R/W
|
|- style="background-color:#CCFFFF;"
|634AC06
| [[Constant class/TypedefPath property|TypedefPath]]
|Returns the path to the type definition if the constant is linked to a type definition. Otherwise, LabVIEW returns an empty path.
|R
|
|- style="background-color:#CCFFFF;"
|634AC08
| [[Constant class/TypedefVI property|TypedefVI]]
|Returns a reference to the type definition if the constant is connected to a type definition. Otherwise, LabVIEW returns .
|R
|
|- style="background-color:#CCFFFF;"
|634AC00
| [[Constant class/Value property|Value]]
|Provides the value of the constant, which is an LV Variant.
|R/W
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Constant Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Constant Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|634A802
| [[Constant class/Change to Control method|Change to Control]]
|Changes the constant to a control and returns a reference to the control. LabVIEW automatically closes the reference to the constant.
|
|- style="background-color:#CCFFFF;"
|634A803
| [[Constant class/Change to Indicator method|Change to Indicator]]
|Changes the constant to an indicator and returns a reference to the indicator. LabVIEW automatically closes the reference to the constant.
|
|- style="background-color:#CCFFFF;"
|634A807
| [[Constant class/Change to Shared Variable Node method|Change to Shared Variable Node]]
|Changes the constant to a Shared Variable node and returns a reference to the Shared Variable node. If you do not specify a shared variable to bind to the node, LabVIEW creates a new shared variable. LabVIEW automatically closes the reference to the constant.
|
|- style="background-color:#CCFFFF;"
|634A804
| [[Constant class/Copy Data method|Copy Data]]
|Copies the data associated with the constant and saves it to the clipboard.
|
|- style="background-color:#CCFFFF;"
|634A800
| [[Constant class/Discon Typedef method|Discon Typedef]]
|Disconnects the constant from the type definition and returns TRUE. If the constant is not connected to a type definition, LabVIEW returns FALSE.
|
|- style="background-color:#CCFFFF;"
|634A806
| [[Constant class/Paste Data method|Paste Data]]
|Places the data from the clipboard into the constant.
|
|- style="background-color:#CCFFFF;"
|634A801
| [[Constant class/Update Typedef method|Update Typedef]]
|Updates the constant from the type definition and returns TRUE. If the constant is not connected to a type definition, LabVIEW returns FALSE.
 
In most cases, LabVIEW correctly preserves the default values of each instance when updating from the type definition. However, if LabVIEW is unable to map the previous default values to the updated controls or constants when updating instances, LabVIEW may lose or incorrectly preserve the default values of instances LabVIEW updates programmatically. Avoid updating type definition instances programmatically if the instances have custom default values and you plan to make extensive changes to the type definition.
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
Line 145: Line 25:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
[[Category:VI Scripting Class]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 01:44, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Constant class
Class ID 16386
Scope VI Scripting
Class Inheritance
Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

The Constant class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Constant Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Constant Properties Table
Property ID Long Name (English) Description R/W RTE
634AC00ValueProvides the value of the constant, which is an LV Variant.Read/WriteNo
634AC01DescriptionProvides a description of the constant.Read/WriteNo
634AC02LabelReturns a reference to the label.Read OnlyNo
634AC03Tip StripGets or sets the tip strip of a constant. A tip strip is the brief description of the object that appears when you move the cursor over the object.Read/WriteNo
634AC04TerminalReturns a reference to the terminal.Read OnlyNo
634AC05Is Typedef?Returns whether the constant is linked to the type definition.Read OnlyNo
634AC06Typedef:PathReturns the path to the type definition if the constant is linked to a type definition. Otherwise, LabVIEW returns an empty path.Read OnlyNo
634AC07Auto-Update From TypedefIf TRUE, the constant automatically updates when the type definition changes.Read/WriteNo
634AC08Typedef:VIReturns a reference to the type definition if the constant is connected to a type definition. Otherwise, LabVIEW returns <NotARef>.Read OnlyNo

Methods

Show/Hide Constant Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Constant Methods Table
Method ID Long Name (English) Description RTE
634A800Disconnect From TypedefDisconnects the constant from the type definition and returns TRUE. If the constant is not connected to a type definition, LabVIEW returns FALSE.No
634A801Update From TypedefUpdates the constant from the type definition and returns TRUE. If the constant is not connected to a type definition, LabVIEW returns FALSE.No
634A802Change to ControlChanges the constant to a control and returns a reference to the control. LabVIEW automatically closes the reference to the constant.No
634A803Change to IndicatorChanges the constant to an indicator and returns a reference to the indicator. LabVIEW automatically closes the reference to the constant.No
634A804Copy DataCopies the data associated with the constant and saves it to the clipboard.No
634A806Paste DataPlaces the data from the clipboard into the constant.No
634A807Change to Shared Variable NodeChanges the constant to a Shared Variable node and returns a reference to the Shared Variable node. If you do not specify a shared variable to bind to the node, LabVIEW creates a new shared variable. LabVIEW automatically closes the reference to the constant.No

Events

This class has no events or it inherits events from its parent: GObject Class.


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=Constant_class&oldid=26556"