Jump to content

Path class

From LabVIEW Wiki
Revision as of 01:16, 31 August 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 class
Class ID {{{1}}}
Scope
Class Inheritance

This class is a top-level class.

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 Short Name (English) Description R/W RTE
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.

Use the Control events for more control over how users drag items within controls.

R/W X
6336814 BrwsButRect R X
633680C BrwsButDisable Specifies whether the browse button of a path control can be operated. R/W X
633680B BrwsButVis Specifies if the path control browse button is visible.

This property is similar to the Visible Items»Browse Button item on the shortcut menu of a path control and Show browse button checkbox on the Appearance page of the Path Properties dialog box.

R/W X
6336816 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 Path Properties dialog box.

Elements:
Name Description
Prompt Sets or gets the prompt string of the browse dialog box.
Match Pattern Sets or gets the match pattern string of the browse dialog box.
Select Mode Sets or gets the selection mode of the browse dialog box.
Start Path Sets or gets the start path of browse dialog box.
Pattern Label Label to display in the file dialog box next to the custom pattern.
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.
R/W X
6336813 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 OK.

This property is similar to the button label parameter in the File Dialog Express VI and the Button Text option on the Browse Options page of the Path Properties dialog box.

This property is an element of the Browse Options property.

R/W X
6336808 MatchPttn Set or get the match pattern string of the browse dialog box.

This property is similar to the pattern parameter in the File Dialog Express VI and the Pattern option on the Browse Options page of the Path Properties dialog box.

This property is an element of the Browse Options property.

R/W X
633680D 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 pattern label parameter in the File Dialog Express VI and the Pattern Label option on the Browse Options page of the Path Properties dialog box.

This property is an element of the Browse Options property.

R/W X
6336807 Prompt Set or get the prompt string of the browse dialog box.

This property is similar to the prompt parameter in the File Dialog Express VI and the Prompt option on the Browse Options page of the Path Properties dialog box.

This property is an element of the Browse Options property.

R/W X
6336809 SelMode Set or get the selection mode of the browse dialog box.

This property is similar to the Selection Mode section in the configuration dialog box for the File Dialog Express VI and the Selection Mode section on the Browse Options page of the Path Properties 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.

new or existing dir (use LLBs)
File or Directory
existing file
new file
new or existing file
existing dir
new dir
new or existing dir
existing file (use LLBs)
new file (use LLBs)
new or existing file (use LLBs)
new or existing file or directory (use LLBs)
existing dir (use LLBs)
new dir (use LLBs)
R/W X
633680A StartPath Set or get the start path of browse dialog box.

This property is similar to the start path parameter in the File Dialog Express VI and the Start Path option on the Browse Options page of the Path Properties dialog box.

This property is an element of the Browse Options property.

R/W X
6336801 DefVal Gets or sets the default value of the path control. R/W X
6336805 Text Reference to the path text.

You can use this reference with the Text properties.

R X
6336817 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 Path too long to fit pull-down menu on the Appearance page of the Properties dialog box to specify how to display long paths.

R/W X
6336812 Scrollbar Displays a vertical scroll bar for a path object. R/W X
6336818 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 Path too long to fit pull-down menu on the Appearance page of the Properties dialog box.

R X
633680F 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 Size Height and Size Width options on the Appearance page of the Properties dialog box.

R/W X
6336811 Height Height of the path control in pixels.

This property is an element of the Size property. This property is similar to the Size Height and Size Width options on the Appearance page of the Properties dialog box.

R/W X
6336810 Width Width of the path control in pixels.

This property is an element of the Size property. This property is similar to the Size Width option on the Appearance page of the Properties dialog box.

R/W X
6336800 Value Value of the path control. R/W X
633680E 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

Methods

No Methods for this class.

Events

No Events for this class.

History

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

See Also

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