Jump to content

Property class

From LabVIEW Wiki
Revision as of 23:43, 1 September 2019 by Q (talk | contribs) (Started page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Property class
Class ID 16419
Scope VI Scripting
Class Inheritance
Class Children

This class has no children.


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

    Properties

    Show/Hide Property Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    Property Properties Table
    Property ID Short Name (English) Description R/W RTE
    636F80E AllProps() Lists all properties supported for the current class.

    Some properties have a Unique ID string. The Unique ID string is consistent across all versions and locales of LabVIEW. Properties without a Unique ID string return an empty string. All properties return Data name, Short name (localized), and Long name (localized), which contain the strings shown to the user in this version and locale of LabVIEW; however, strings can vary across versions, locales, and even individual launches of LabVIEW.

    R
    636F80B Flags.HasDeprecated R
    636F810 Flags.HasIgnoreErrors Returns TRUE if Ignore Errors inside Node is set for the Property Node. You can set a Property Node to ignore errors by right-clicking the Property Node and selecting Ignore Errors inside Node from the shortcut menu or by setting the Ignore Error Inside Node property. R
    636F80C Flags.HasMustRunAtRootLoop R
    636F808 Flags.HasNotAvailInAppLibs R
    636F809 Flags.HasPrivate R
    636F80A Flags.HasScripting R
    636F805 IgnoreErr? Sets or gets the option to ignore individual property errors. R/W
    636F806 LinkedControl Returns a reference to a front panel control if the property node links to the control.

    This property returns a NULL reference and an error if the property node does not link to a front panel control.

    R X
    636F80F Props() Gets information about the properties selected in this node.

    Some properties have a Unique ID string. The Unique ID string is consistent across all versions and locales of LabVIEW. Properties without a Unique ID string return an empty string. If this node has an invalid property selected, this property returns empty strings for Unique ID string, Data name, Short name, and Long name. This property is read only. Use the Set Properties method to change the currently selected properties.

    R
    636F803 PropCount Sets or gets the number of properties in the property node. R/W
    636F802 PropItems() Returns references to individual items of the property node. R
    636F804 PropClassName Sets or gets the class name for the property node.

    If you set the class name, include the full names for the server class and the node class, separated by a colon. VI Server:Generic is an example of a class name.

    R/W

    Methods

    Show/Hide Property Methods Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    Property Methods Table
    Method ID Short Name (English) Description RTE
    636F401 AddPropertyItemAfter Adds a new property item after the item you specify in Index and returns a reference to the new property item. X
    636F404 DisconnectFromControl Disconnects the property node from a control. X
    636F400 Get Prop Item Returns a reference to the property item you specify with index.
    636F403 LinkToControl Links the property node to the control you specify. The link to the control is available only when you do not wire data to the Reference input. If you wire data to the Reference input, LabVIEW returns an error. X
    636F402 RemovePropertyItem Removes the property item at the index you specify. X
    636F405 [[Property class/SetProperties[] method|SetProperties[]]] Sets the properties for this Property Node.
    636F406 SetProperties_AllowPrivate

    Events

    No Events for this class.

    History

    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also