Path class

From LabVIEW Wiki
Jump to: navigation, search
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