PathEdit Class

The PathEdit is a simple component that allows the user to enter a path or to browse for it. The user can open a browse dialog by pressing the button on the right. Use the Path property to set a default path or the get the path that the user has finally chosen. Use The FolderMode property to define if the user should enter / browse for a path to a file or a folder.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsUserControl
              Jam.ShellPathEdit

Namespace: Jam.Shell
Assembly: ShellBrowser (in ShellBrowser.dll) Version: 7.2

Syntax

C++

Copy

public class PathEdit : UserControl, INotifyPropertyChanged, 
	ISupportInitialize

Public Class PathEdit
	Inherits UserControl
	Implements INotifyPropertyChanged, ISupportInitialize

public ref class PathEdit : public UserControl, 
	INotifyPropertyChanged, ISupportInitialize

type PathEdit = 
    class
        inherit UserControl
        interface INotifyPropertyChanged
        interface ISupportInitialize
    end

The PathEdit type exposes the following members.

Constructors

	Name	Description
	PathEdit	Initializes a new instance of the PathEdit class.

Top

Properties

	Name	Description
	Button	Gives access to the embedded Button.
	ContextMenuStrip	Get or set the contextmenu strip of the control. (Overrides ControlContextMenuStrip)
	DefaultExt	Gets or sets the default file name extension. Example: "txt"
	DialogTitle	Change the window title of the browse dialog, that will be opened if the user pressed the browse button on the right.
	FileBrowserDialog	Returns a reference to an OpenFileDialog
	FileFilter	Edit your own filter options for the opendialog. Example: Image Files(.BMP;.JPG;.GIF)\|.BMP;.JPG;.GIF\|All files (.)\|.
	FileNames	Contains the selected files from the FileBrowserDialog.
	Focused	Gets a value indicating whether the TextBox control has input focus.
	FolderBrowserDialog	Returns a reference to a FolderBrowserDialog.
	FolderMode	Use this property to select if the dialog for browsing for a file, or for a folder should be displayed.
	IsInitializing	The value this property is true between the calls BeginInit() and EndInit() of the ISupportInitialize interface.
	IsValidPath	Check if the selected file or folder is existing on your system at the moment.
	Path	Use this property to get or set the path in the edit field.
	ShellAutoCompletionMode	This property controls the availability of the shells autocompletion mode, if set to FileSystem, Url or both, the PathEdit control provides autocompletion mode with a via a drop down box. If disabled the default behavior is used. Both, FileSystem and Url can be specified at once. FileSystem is enabled by default. Url needs to be used to also provide autocompletion for UNC-Paths.
	Text	Get or set the text visible in the editor. (Overrides UserControl.Text)
	TextBox	Gives access to the embedded TextBox.
	ToolTip	Sets the ToolTip text for the embedded TextBox.
	Version	The current version of the ShellBrowser.

Top

Methods

	Name	Description
	BeginInit	Signals the object that initialization is starting.
	BrowseForFile	Internal method, which handles the browsing for files.
	BrowseForFolder	Internal method, which handles the browsing for folders.
	EndInit	Signals the object that initialization is complete.
	Focus	Sets input focus to the TextBox control.
	OnChange	Fires the Change event, when the text in the TextBox changes.
	OnCreateControl	Raises the CreateControl event. (Overrides UserControlOnCreateControl)
	OnFontChanged	Raises the FontChanged event. (Overrides ContainerControlOnFontChanged(EventArgs))
	OnResize	Handles the resizing of PathEdit component. (Overrides UserControlOnResize(EventArgs))

Top

Events

	Name	Description
	BeforeShowDialog	Occurs before a dialog for file/folder selection is shown after the button of the PathEdit control has been clicked.
	ButtonClick	This event occurs if the button of the PathEdit control has been clicked.
	Change	Occurs when the Text in the TextBox changes.
	EditFieldClick	This event occurs if the user clicked on the editfield.
	EditFieldEnter	Occurs when the edit field is entered and gains focus
	EditFieldKeyDown	Occurs when a key is pressed while the edit field has focus
	EditFieldKeyPress	Occurs when a key is pressed while the edit field has focus
	EditFieldKeyUp	Occurs when a key is released while the edit field has focus
	EditFieldLeave	Occurs when the edit field is left and lost focus
	PropertyChanged	This event is issued if the TextField in the PathEdit changed. It is available here to be able to add a DataBinding to the Path.

Top

Extension Methods

	Name	Description
	GetSelfAndDescendants	Returns a flattened collection of a control and all of its descendant controls. (Defined by ExtensionMethods)
	HandleNeeded	A Control extension method that ensures that the handle for a control is created. (Defined by ExtensionMethods)
	ScaledPixels	An extension method for controls: It scales the passed pixels according to the current dpi the control is displayed with. (Defined by ExtensionMethods)
	ScaleFont	A Control extension method that scales font according to the passed factor. (Defined by ExtensionMethods)

Top

Reference

Jam.Shell Namespace