Jump to content

Path class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
Removed template
 
(3 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide Path Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide Path Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"  
|+ Path Properties Table
|+ Path Properties Table
! Property ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! R/W
! R/W
! RTE
! RTE  
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6336815
| 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]]
| [[Path class/Allow Dropping property|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.
| 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
Use the Control events for more control over how users drag items within controls.
| Yes
|R/W
|- style="background-color:#FFFFCC;"  
|X
| data-sort-value=104032278 |6336816
|- style="background-color:#D1BB80;"
| [[Path class/Browse Options property|Browse Options]]
|6336814
| Set or get the file dialog box options. The options include prompt, mode, start path, and button text.
| [[Path class/BrwsButRect property|BrwsButRect]]
| Read/Write
|
| Yes
|R
|- style="background-color:#FFFFCC;"  
|X
| data-sort-value=104032279 |6336817
|- style="background-color:#FFFFCC;"
| [[Path class/Path Too Long To Fit property|Path Too Long To Fit]]
|633680C
| 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.
| [[Path class/BrwsButDisable property|BrwsButDisable]]
| Read/Write
|Specifies whether the browse button of a path control can be operated.
| Yes
|R/W
|- style="background-color:#FFFFCC;"  
|X
| data-sort-value=104032280 |6336818
|- style="background-color:#FFFFCC;"
| [[Path class/Shows Abbreviated Behavior? property|Shows Abbreviated Behavior?]]
|633680B
| 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.
| [[Path class/BrwsButVis property|BrwsButVis]]
| Read Only
|Specifies if the path control browse button is visible.
| Yes
 
This property is similar to the <b>Visible Items&#0187;Browse Button</b> item on the shortcut menu of a path control and <b>Show browse button</b> checkbox on the Appearance page of the <b>Path Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336816
| [[Path class/BrowseOptions property|BrowseOptions]]
|Set or get the file dialog box options. The options include prompt, mode, start path, and button text.
 
This property is similar to the options on the Browse Options page of the <b>Path Properties</b> dialog box.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Prompt
|Sets or gets the prompt string of the browse dialog box.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Match Pattern
|Sets or gets the match pattern string of the browse dialog box.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Select Mode
|Sets or gets the selection mode of the browse dialog box.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Start Path
|Sets or gets the start path of browse dialog box.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Pattern Label
|Label to display in the file dialog box next to the custom pattern.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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 <b>OK</b>.
|}
|}
|R/W
</div></div>
|X
|- style="background-color:#FFFFCC;"
|6336813
| [[Path class/ButtonText property|ButtonText]]
|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 <b>OK</b>.
 
This property is similar to the <b>button label</b> parameter in the File Dialog Express VI and the <b>Button Text</b> option on the Browse Options page of the <b>Path Properties</b> dialog box.
 
This property is an element of the Browse Options property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336808
| [[Path class/MatchPttn property|MatchPttn]]
|Set or get the match pattern string of the browse dialog box.
 
This property is similar to the <b>pattern</b> parameter in the File Dialog Express VI and the <b>Pattern</b> option on the Browse Options page of the <b>Path Properties</b> dialog box.


This property is an element of the Browse Options property.
== Methods ==
|R/W
''This class has no methods or it inherits methods from its parent: [[Control class#Methods|Control Class]].''
|X
|- style="background-color:#FFFFCC;"
|633680D
| [[Path class/PttnLabel property|PttnLabel]]
|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.


This property is similar to the <b>pattern label</b> parameter in the File Dialog Express VI and the <b>Pattern Label</b> option on the Browse Options page of the <b>Path Properties</b> dialog box.
== Events ==
 
''This class has no events or it inherits events from its parent: [[Control class#Events|Control Class]].''
This property is an element of the Browse Options property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336807
| [[Path class/Prompt property|Prompt]]
|Set or get the prompt string of the browse dialog box.
 
This property is similar to the <b>prompt</b> parameter in the File Dialog Express VI and the <b>Prompt</b> option on the Browse Options page of the <b>Path Properties</b> dialog box.
 
This property is an element of the Browse Options property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336809
| [[Path class/SelMode property|SelMode]]
|Set or get the selection mode of the browse dialog box.
 
This property is similar to the <b>Selection Mode</b> section in the configuration dialog box for the File Dialog Express VI and the <b>Selection Mode</b> section on the Browse Options page of the <b>Path Properties</b> dialog box.
 
This property is an element of the Browse Options property.
 
 
The following table lists the possible file or directory enum values for the Browse Options:Selection Mode property.
 
{| class="wikitable"
! scope="col" style="text-align:left;"| File or Directory
|- style="vertical-align:top;"
|<b>existing file</b>
|- style="vertical-align:top;"
|<b>new file</b>
|- style="vertical-align:top;"
|<b>new or existing file</b>
|- style="vertical-align:top;"
|<b>existing dir</b>
|- style="vertical-align:top;"
|<b>new dir</b>
|- style="vertical-align:top;"
|<b>new or existing dir</b>
|- style="vertical-align:top;"
|<b>existing file (use LLBs)</b>
|- style="vertical-align:top;"
|<b>new file (use LLBs)</b>
|- style="vertical-align:top;"
|<b>new or existing file (use LLBs)</b>
|- style="vertical-align:top;"
|<b>new or existing file or directory (use LLBs)</b>
|- style="vertical-align:top;"
|<b>existing dir (use LLBs)</b>
|- style="vertical-align:top;"
|<b>new dir (use LLBs)</b>
|- style="vertical-align:top;"
<b>new or existing dir (use LLBs)</b>
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|633680A
| [[Path class/StartPath property|StartPath]]
|Set or get the start path of browse dialog box.
 
This property is similar to the <b>start path</b> parameter in the File Dialog Express VI and the <b>Start Path</b> option on the Browse Options page of the <b>Path Properties</b> dialog box.
 
This property is an element of the Browse Options property.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6336801
| [[Path class/DefVal property|DefVal]]
|Gets or sets the default value of the path control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336805
| [[Path class/Text property|Text]]
|Reference to the path text.
 
You can use this reference with the Text properties.
|R
|X
|- style="background-color:#FFFFCC;"
|6336817
| [[Path class/PTooLngToFt property|PTooLngToFt]]
|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.
 
You also can use the <b>Path too long to fit</b> pull-down menu on the Appearance page of the Properties dialog box to specify how to display long paths.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336812
| [[Path class/Scrollbar property|Scrollbar]]
|Displays a vertical scroll bar for a path object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336818
| [[Path class/ShwsAbbrdBhvior? property|ShwsAbbrdBhvior?]]
|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.
 
This property is similar to the <b>Path too long to fit</b> pull-down menu on the Appearance page of the Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|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.
 
This property is similar to the <b>Size Height</b> and <b>Size Width</b> options on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336811
| [[Path class/Height property|Height]]
|Height of the path control in pixels.
 
This property is an element of the Size property. This property is similar to the <b>Size Height</b> and <b>Size Width</b> options on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336810
| [[Path class/Width property|Width]]
|Width of the path control in pixels.
 
This property is an element of the Size property. This property is similar to the <b>Size Width</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6336800
| [[Path class/Value property|Value]]
|Value of the path control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633680E
| [[Path class/Val(Sgnl) property|Val(Sgnl)]]
|Sets the value of the control and generates a Value Change event.
 
This property updates the value of an object similar to the Value property. However, Value (Signaling) also causes LabVIEW to generate an event as if the user had interactively changed the value of the object. National Instruments recommends you use this property only when you rely on LabVIEW generating an event in response to the programmatic value change.
|W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
''No Events for this 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 269: Line 193:
*[[VI Scripting]]
*[[VI Scripting]]


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

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"