Jump to content

Path class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
Replaced with template tables
Tag: Replaced
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 Path Properties Table</span>
{{VIServerClassTables|11}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Path Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6336815
| [[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.
 
Use the Control events for more control over how users drag items within controls.
|R/W
|X
|- style="background-color:#D1BB80;"
|6336814
| [[Path class/BrwsButRect property|BrwsButRect]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|633680C
| [[Path class/BrwsButDisable property|BrwsButDisable]]
|Specifies whether the browse button of a path control can be operated.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633680B
| [[Path class/BrwsButVis property|BrwsButVis]]
|Specifies if the path control browse button is visible.
 
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
|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.
|R/W
|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.
 
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 ==

Revision as of 22:28, 8 September 2019

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.


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
6336800ValueValue of the path control.Read/WriteYes
6336801Default ValueGets or sets the default value of the path control.Read/WriteYes (Read Only)
6336802Text SizeRead/WriteYes
6336803Text Size:WidthWidth of the path control in pixels.Read/WriteYes
6336804Text Size:HeightHeight of the path control in pixels.Read/WriteYes
6336805Path TextReference to the path text.Read OnlyYes
6336806Browse Dialog Options (Deprecated)Read/WriteYes
6336807Browse Options:PromptSet or get the prompt string of the browse dialog box.Read/WriteYes
6336808Browse Options:Match PatternSet or get the match pattern string of the browse dialog box.Read/WriteYes
6336809Browse Options:Selection ModeSet or get the selection mode of the browse dialog box.Read/WriteYes
633680ABrowse Options:Start PathSet or get the start path of browse dialog box.Read/WriteYes
633680BBrowse Button:VisibleSpecifies if the path control browse button is visible.Read/WriteYes
633680CBrowse Button:DisabledSpecifies whether the browse button of a path control can be operated.Read/WriteYes
633680DBrowse Options:Pattern LabelLabel 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/WriteYes
633680EValue (Signaling)Sets the value of the control and generates a Value Change event.Write OnlyYes
633680FSizeWidth and height in pixels of the frame around the text area of the path control, not including the browse button.Read/WriteYes
6336810Size:WidthWidth of the path control in pixels.Read/WriteYes
6336811Size:HeightHeight of the path control in pixels.Read/WriteYes
6336812Scrollbar VisibleDisplays a vertical scroll bar for a path object.Read/WriteYes
6336813Browse Options:Button TextSpecifies 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/WriteYes
6336814Browse Button RectRead OnlyYes
6336815Allow DroppingIf 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/WriteYes
6336816Browse OptionsSet or get the file dialog box options. The options include prompt, mode, start path, and button text.Read/WriteYes
6336817Path Too Long To FitSpecifies 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/WriteYes
6336818Shows 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 OnlyYes

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 2018 More info to come.

See Also