Loading...

Class ExplorerControl

Control used for the navigation part of the RadOpenFileDialog, RadSaveFileDialog and RadOpenFolderDialog

Inheritance
System.Object
ExplorerControl
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class ExplorerControl : UserControl, IViewModelChangedListener, IThemeChangeListener

Constructors

ExplorerControl()

Declaration
public ExplorerControl()

Properties

ControlThemeClassName

Declaration
public string ControlThemeClassName { get; }
Property Value
System.String

Implements

CurrentDirectoryPath

Gets or sets a value indicating the path of the current directory in this ExplorerControl instance.

Declaration
public string CurrentDirectoryPath { get; set; }
Property Value
System.String

CustomPlacesPaths

Gets or sets the paths to the custom places navigation tree view.

Declaration
public IEnumerable<string> CustomPlacesPaths { get; set; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

CustomPlacesTreeNode

Declaration
public RadTreeNode CustomPlacesTreeNode { get; }
Property Value
RadTreeNode

EditingOptions

Gets or sets how the files and folders in the ExplorerControl can be edited. Note that the shell context menu and drag and drop operations are handled separately.

Declaration
public EditingOptions EditingOptions { get; set; }
Property Value
EditingOptions

ExpandToCurrentDirectory

Gets or sets a value indicating whether the main navigation pane expands and brings into view the current directory.

Declaration
public bool ExpandToCurrentDirectory { get; set; }
Property Value
System.Boolean

FileBrowserListView

Declaration
public FileBrowserListView FileBrowserListView { get; }
Property Value
FileBrowserListView

Filter

Gets or sets the filter string that describes the list of extensions to filter by. It has effect only when IsFolderBrowser is False.

Declaration
public string Filter { get; set; }
Property Value
System.String

FilterDescriptors

Gets the list of the FileFilterDescriptor specified by the Filter property. It has effect only when IsFolderBrowser is False.

Declaration
public IList<FileFilterDescriptor> FilterDescriptors { get; }
Property Value
System.Collections.Generic.IList<FileFilterDescriptor>

FilterIndex

Gets or sets a value indicating the current filter index from the list of filter strings specified by the Filter property. It has effect only when IsFolderBrowser is False.

Declaration
public int FilterIndex { get; set; }
Property Value
System.Int32

IsDragDropEnabled

Gets or sets a value indicating whether this ExplorerControl allows drag-drop operations.

Declaration
public bool IsDragDropEnabled { get; set; }
Property Value
System.Boolean

IsFolderBrowser

Gets or sets a value indicating whether this ExplorerControl instance is used for directories selection or both directories and files.

Declaration
public bool IsFolderBrowser { get; set; }
Property Value
System.Boolean

LayoutType

Gets or sets the current LayoutType of the Main pane.

Declaration
public LayoutType LayoutType { get; set; }
Property Value
LayoutType

MainNavigationTreeView

Declaration
public FileBrowserTreeView MainNavigationTreeView { get; }
Property Value
FileBrowserTreeView

MainNavigationTreeViewProportionalWidth

Gets or sets the proportional size of MainNaigationTreeView according to the total width of the ExplorerControl. Note that this property is considered only when SizeMode is set to Proportional. Default value is 0.25

Declaration
public float MainNavigationTreeViewProportionalWidth { get; set; }
Property Value
System.Single

MinFileBrowserListViewWidth

Gets or sets the minimum width for FileBrowserListView when the ExplorerControl is resized or the separator is dragged.

Declaration
public int MinFileBrowserListViewWidth { get; set; }
Property Value
System.Int32

MinNavigationTreeViewWidth

Gets or sets the minimum width for MainNavigationTreeView when the ExplorerControl is resized or the separator is dragged.

Declaration
public int MinNavigationTreeViewWidth { get; set; }
Property Value
System.Int32

MultiSelect

Gets or sets a value indicating whether multiple selection of files or folders is allowed.

Declaration
public bool MultiSelect { get; set; }
Property Value
System.Boolean

PathNavigationBreadCrumb

Declaration
public FileDialogsBreadcrumb PathNavigationBreadCrumb { get; }
Property Value
FileDialogsBreadcrumb

SearchTextBox

Declaration
public FileDialogSearchPane SearchTextBox { get; }
Property Value
FileDialogSearchPane

SelectedFileName

Gets the full path of the currently selected file or directory.

Declaration
public string SelectedFileName { get; }
Property Value
System.String

SelectedFileNames

Gets the list of full paths of the currently selected files and / or folders.

Declaration
public IList<string> SelectedFileNames { get; }
Property Value
System.Collections.Generic.IList<System.String>

SelectedSafeFileNames

Gets the list of names of the currently selected files and / or folders.

Declaration
public IList<string> SelectedSafeFileNames { get; }
Property Value
System.Collections.Generic.IList<System.String>

ShowHiddenFiles

Gets or sets a boolean value indicating whether hidden files and folders should be visible in the Explorer.

Declaration
public bool ShowHiddenFiles { get; set; }
Property Value
System.Boolean

ShowNetworkLocations

Gets or sets a value indicating whether the dialog shows network computers in the navigation tree.

Declaration
public bool ShowNetworkLocations { get; set; }
Property Value
System.Boolean

ShowSystemCustomPlaces

Gets or sets a value indicating whether the QuickAccess/Favorites items from the Windows FileExplorer will be shown as child nodes in the CustomPlacesTreeNode.

Declaration
public bool ShowSystemCustomPlaces { get; set; }
Property Value
System.Boolean

SizeMode

Gets or sets a value indicating how the MainNavigationTreeView width will be changed when the ExplorerControl is resized.

Declaration
public ExplorerControlSizeMode SizeMode { get; set; }
Property Value
ExplorerControlSizeMode

ThemeName

Declaration
public string ThemeName { get; set; }
Property Value
System.String

ViewModel

Declaration
public DialogViewModel ViewModel { get; }
Property Value
DialogViewModel

ViewModelChangedListeners

Declaration
public IList<IViewModelChangedListener> ViewModelChangedListeners { get; set; }
Property Value
System.Collections.Generic.IList<IViewModelChangedListener>

Methods

AddCustomPlacesNode(String, Image, IList<String>)

Adds a new custom places node to the MainNavigationTreeView. This node can be used to add organized shortcuts. For example: Favorites, Libraries etc.

Declaration
public CustomPlacesFileBrowserTreeNode AddCustomPlacesNode(string nodeName, Image nodeImage, IList<string> paths)
Parameters
System.String nodeName

The name of custom places node.
System.Drawing.Image nodeImage

The image of custom places node.
System.Collections.Generic.IList<System.String> paths

The list of paths that will be displayed as children of the newly created node.
Returns
CustomPlacesFileBrowserTreeNode

AddSystemCustomPlaces()

Declaration
protected virtual void AddSystemCustomPlaces()

CreateCustomPlacesNode()

Declaration
protected virtual CustomPlacesFileBrowserTreeNode CreateCustomPlacesNode()
Returns
CustomPlacesFileBrowserTreeNode

CreateTreeNode(DirectoryBaseWrapper)

Declaration
public FileBrowserTreeNode CreateTreeNode(DirectoryBaseWrapper dir)
Parameters
DirectoryBaseWrapper dir

Returns
FileBrowserTreeNode

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.

GetControlsHeightForCurrentTheme(String, out Boolean)

Declaration
protected virtual int GetControlsHeightForCurrentTheme(string themeName, out bool hideButtonsFillAndBorder)
Parameters
System.String themeName

System.Boolean hideButtonsFillAndBorder

Returns
System.Int32

GetDirectoryInfoWrappersFromPaths(IEnumerable<String>)

Declaration
public List<DirectoryInfoWrapper> GetDirectoryInfoWrappersFromPaths(IEnumerable<string> paths)
Parameters
System.Collections.Generic.IEnumerable<System.String> paths

Returns
System.Collections.Generic.List<DirectoryInfoWrapper>

GetLayoutTypeToIconConverter()

Declaration
protected virtual LayoutTypeToIconConverter GetLayoutTypeToIconConverter()
Returns
LayoutTypeToIconConverter

NotifyViewModelListeners(DialogViewModel)

Declaration
protected void NotifyViewModelListeners(DialogViewModel viewModel)
Parameters
DialogViewModel viewModel

OnCurrentDirectoryPathChanged()

Declaration
protected virtual void OnCurrentDirectoryPathChanged()

OnFileDirectoryChanged(Action)

Declaration
public void OnFileDirectoryChanged(Action action)
Parameters
System.Action action

OnFilterChanged()

Declaration
protected virtual void OnFilterChanged()

OnFilterIndexChanged()

Declaration
protected virtual void OnFilterIndexChanged()

OnIsDragDropEnabledPropertyChanged()

Declaration
protected virtual void OnIsDragDropEnabledPropertyChanged()

OnLayoutChanged()

Declaration
protected virtual void OnLayoutChanged()

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMultiSelectChanged()

Declaration
protected virtual void OnMultiSelectChanged()

OnShowHiddenFilesChanged()

Declaration
protected virtual void OnShowHiddenFilesChanged()

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
System.EventArgs e

OnThemeChanged(ThemeChangedEventArgs)

Declaration
public void OnThemeChanged(ThemeChangedEventArgs e)
Parameters
ThemeChangedEventArgs e

Implements

OnViewModelChanged(DialogViewModel)

Declaration
protected virtual void OnViewModelChanged(DialogViewModel viewModel)
Parameters
DialogViewModel viewModel

SetupControlsForTheme()

Declaration
protected virtual void SetupControlsForTheme()

SetupControlsForTheme(String)

Declaration
protected virtual void SetupControlsForTheme(string themeName)
Parameters
System.String themeName

SetupViewModelListeners()

Declaration
protected void SetupViewModelListeners()

SetViewModel(DialogViewModel)

Declaration
public void SetViewModel(DialogViewModel viewModel)
Parameters
DialogViewModel viewModel

Implements

WireEvents()

Declaration
protected virtual void WireEvents()

Events

DirectoryNavigating

Occurs when the current folder is about to change.

Declaration
public event EventHandler<DirectoryNavigatingEventArgs> DirectoryNavigating
Event Type
System.EventHandler<DirectoryNavigatingEventArgs>

DirectoryRequesting

Occurs when the DirectoryInfo wrapper is about to be created.

Declaration
public event EventHandler<DirectoryRequestingEventArgs> DirectoryRequesting
Event Type
System.EventHandler<DirectoryRequestingEventArgs>

ExceptionRaised

Occurs when Exception during File (or Directory) creation / observation / modification is raised.

Declaration
public event EventHandler<FileBrowserExceptionRaisedEventArgs> ExceptionRaised
Event Type
System.EventHandler<FileBrowserExceptionRaisedEventArgs>

ShellContextMenuOpening

Occurs when context menu is about to open.

Declaration
public event EventHandler<ContextMenuOpeningEventArgs> ShellContextMenuOpening
Event Type
System.EventHandler<ContextMenuOpeningEventArgs>

Extension Methods