Jump to content

Path class: Difference between revisions

From LabVIEW Wiki
← Older edit
Visual
m Removed VI Server Category from page
Removed template
 
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
== Properties ==
{{VIServerClassTables|11}}
<span class="mw-customtoggle-propertiestable">Show/Hide Path Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
|+ Path Properties Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
| data-sort-value=104032256 |6336800
| [[Path class/Value property|Value]]
| Value of the path control.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104032257 |6336801
| [[Path class/Default Value property|Default Value]]
| Gets or sets the default value of the path control.
| Read/Write
| Yes (Read Only)
|- style="background-color:#FFAAAA;"
| data-sort-value=104032258 |6336802
| [[Path class/Text Size property|Text Size]]
|
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=104032259 |6336803
| [[Path class/Text Size.Width property|Text Size:Width]]
| Width of the path control in pixels.
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=104032260 |6336804
| [[Path class/Text Size.Height property|Text Size:Height]]
| Height of the path control in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032261 |6336805
| [[Path class/Path Text property|Path Text]]
| Reference to the path text.
| Read Only
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=104032262 |6336806
| [[Path class/Browse Dialog Options (Deprecated) property|Browse Dialog Options (Deprecated)]]
|
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032263 |6336807
| [[Path class/Browse Options.Prompt property|Browse Options:Prompt]]
| Set or get the prompt string of the browse dialog box.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032264 |6336808
| [[Path class/Browse Options.Match Pattern property|Browse Options:Match Pattern]]
| Set or get the match pattern string of the browse dialog box.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032265 |6336809
| [[Path class/Browse Options.Selection Mode property|Browse Options:Selection Mode]]
| Set or get the selection mode of the browse dialog box.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032266 |633680A
| [[Path class/Browse Options.Start Path property|Browse Options:Start Path]]
| Set or get the start path of browse dialog box.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032267 |633680B
| [[Path class/Browse Button.Visible property|Browse Button:Visible]]
| Specifies if the path control browse button is visible.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032268 |633680C
| [[Path class/Browse Button.Disabled property|Browse Button:Disabled]]
| Specifies whether the browse button of a path control can be operated.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032269 |633680D
| [[Path class/Browse Options.Pattern Label property|Browse Options:Pattern Label]]
| Label to display in the file dialog box next to the custom pattern. Use the [[Browse Options:Match Pattern]] property to set a custom pattern.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032270 |633680E
| [[Path class/Value (Signaling) property|Value (Signaling)]]
| Sets the value of the control and generates a Value Change event.
| Write Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032271 |633680F
| [[Path class/Size property|Size]]
| Width and height in pixels of the frame around the text area of the path control, not including the browse button.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032272 |6336810
| [[Path class/Size.Width property|Size:Width]]
| Width of the path control in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032273 |6336811
| [[Path class/Size.Height property|Size:Height]]
| Height of the path control in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032274 |6336812
| [[Path class/Scrollbar Visible property|Scrollbar Visible]]
| Displays a vertical scroll bar for a path object.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032275 |6336813
| [[Path class/Browse Options.Button Text property|Browse Options:Button Text]]
| Specifies the label to display in the file dialog box for the accept or OK button. If you do not specify a label, the button text defaults to '''OK'''.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032276 |6336814
| [[Path class/Browse Button Rect property|Browse Button Rect]]
| Returns the coordinates of the rectangle that encloses the browse button for the path control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032277 |6336815
| [[Path class/Allow Dropping property|Allow Dropping]]
| If TRUE, the control automatically accepts paths dragged to it, including the <code>LV_PATH</code> data type from [[drag and drop]] events. The <code>LV_PATH</code> data type is of type path. If FALSE, LabVIEW does not automatically accept any drops, including from the operating system, at run time. LabVIEW returns error 1157 if you set this property on an indicator.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032278 |6336816
| [[Path class/Browse Options property|Browse Options]]
| Set or get the file dialog box options. The options include prompt, mode, start path, and button text.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032279 |6336817
| [[Path class/Path Too Long To Fit property|Path Too Long To Fit]]
| Specifies how to display a path that is too long to fit in the path control or indicator. LabVIEW applies the value of this property only if the scrollbar of the control or indicator is hidden.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104032280 |6336818
| [[Path class/Shows Abbreviated Behavior? property|Shows Abbreviated Behavior?]]
| Returns whether the referenced path control or indicator is currently abbreviating the path. This property returns FALSE if the object is set to clip the path, if the scrollbar is visible, or if the path fits in the path object.
| Read Only
| Yes
|}
</div></div>
 
== Methods ==
''This class has no methods or it inherits methods from its parent: [[Control class#Methods|Control Class]].''
 
== Events ==
''This class has no events or it inherits events from its parent: [[Control class#Events|Control Class]].''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
! Change(s)
! Change(s)
|-
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|[[File:LV2020.png|frameless|border|64x64px|LabVIEW 2020|link=LabVIEW 2020]]
|More info to come.
| In [[LabVIEW 2020]] the [[Path class/Browse Button Rect property|Browse Button Rect property]] was changed from being [[VI Server#Private|Private]] to being part of the [[VI Server#Basic Development Environment|Basic Development Environment]].
|}
|}


== See Also ==
== See Also ==
Line 24: Line 192:
*[[VI Server]]
*[[VI Server]]
*[[VI Scripting]]
*[[VI Scripting]]


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

Latest revision as of 04:03, 15 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Path class
Class ID 11
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


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

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

    Properties

    Show/Hide Path Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    Path Properties Table
    Property ID Long Name (English) Description R/W RTE
    6336800 Value Value of the path control. Read/Write Yes
    6336801 Default Value Gets or sets the default value of the path control. Read/Write Yes (Read Only)
    6336802 Text Size Read/Write Yes
    6336803 Text Size:Width Width of the path control in pixels. Read/Write Yes
    6336804 Text Size:Height Height of the path control in pixels. Read/Write Yes
    6336805 Path Text Reference to the path text. Read Only Yes
    6336806 Browse Dialog Options (Deprecated) Read/Write Yes
    6336807 Browse Options:Prompt Set or get the prompt string of the browse dialog box. Read/Write Yes
    6336808 Browse Options:Match Pattern Set or get the match pattern string of the browse dialog box. Read/Write Yes
    6336809 Browse Options:Selection Mode Set or get the selection mode of the browse dialog box. Read/Write Yes
    633680A Browse Options:Start Path Set or get the start path of browse dialog box. Read/Write Yes
    633680B Browse Button:Visible Specifies if the path control browse button is visible. Read/Write Yes
    633680C Browse Button:Disabled Specifies whether the browse button of a path control can be operated. Read/Write Yes
    633680D Browse Options:Pattern Label Label to display in the file dialog box next to the custom pattern. Use the Browse Options:Match Pattern property to set a custom pattern. Read/Write Yes
    633680E Value (Signaling) Sets the value of the control and generates a Value Change event. Write Only Yes
    633680F Size Width and height in pixels of the frame around the text area of the path control, not including the browse button. Read/Write Yes
    6336810 Size:Width Width of the path control in pixels. Read/Write Yes
    6336811 Size:Height Height of the path control in pixels. Read/Write Yes
    6336812 Scrollbar Visible Displays a vertical scroll bar for a path object. Read/Write Yes
    6336813 Browse Options:Button Text Specifies the label to display in the file dialog box for the accept or OK button. If you do not specify a label, the button text defaults to OK. Read/Write Yes
    6336814 Browse Button Rect Returns the coordinates of the rectangle that encloses the browse button for the path control. Read Only Yes
    6336815 Allow Dropping If TRUE, the control automatically accepts paths dragged to it, including the LV_PATH data type from drag and drop events. The LV_PATH data type is of type path. If FALSE, LabVIEW does not automatically accept any drops, including from the operating system, at run time. LabVIEW returns error 1157 if you set this property on an indicator. Read/Write Yes
    6336816 Browse Options Set or get the file dialog box options. The options include prompt, mode, start path, and button text. Read/Write Yes
    6336817 Path Too Long To Fit Specifies how to display a path that is too long to fit in the path control or indicator. LabVIEW applies the value of this property only if the scrollbar of the control or indicator is hidden. Read/Write Yes
    6336818 Shows Abbreviated Behavior? Returns whether the referenced path control or indicator is currently abbreviating the path. This property returns FALSE if the object is set to clip the path, if the scrollbar is visible, or if the path fits in the path object. Read Only Yes

    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.

    History

    Version Change(s)
    LabVIEW 2020 In LabVIEW 2020 the Browse Button Rect property was changed from being Private to being part of the Basic Development Environment.


    See Also

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