Definition
Namespace:Telerik.Web.UI
Inheritance: Telerik.Web.UI.RadWebControlTelerik.Web.UI.RadFileExplorer
Events
Adds a ajaxRequestEnd event handler for the radfileexplorer
add_ajaxRequestEnd
The event handler function to attach
Adds a ajaxRequestStart event handler for the radfileexplorer
add_ajaxRequestStart
The event handler function to attach
Adds a copy event handler for the radfileexplorer
add_copy
The event handler function to attach
Adds a createNewFolder event handler for the radfileexplorer
add_createNewFolder
The event handler function to attach
Adds a delete event handler for the radfileexplorer
add_delete
The event handler function to attach
Adds a eventHandlersAttached event handler for the radfileexplorer
add_eventHandlersAttached
The event handler function to attach
Adds a fileOpen event handler for the radfileexplorer
add_fileOpen
The event handler function to attach
Adds a folderChange event handler for the radfileexplorer
add_folderChange
The event handler function to attach
Adds a folderLoaded event handler for the radfileexplorer
add_folderLoaded
The event handler function to attach
Adds a init event handler for the radfileexplorer
add_init
The event handler function to attach
Adds a itemSelected event handler for the radfileexplorer
add_itemSelected
The event handler function to attach
Adds a load event handler for the radfileexplorer
add_load
The event handler function to attach
Adds a move event handler for the radfileexplorer
add_move
The event handler function to attach
Removes a ajaxRequestEnd event handler from the radfileexplorer
remove_ajaxRequestEnd
The event handler function to remove
Removes a ajaxRequestStart event handler from the radfileexplorer
remove_ajaxRequestStart
The event handler function to remove
Removes a copy event handler from the radfileexplorer
remove_copy
The event handler function to remove
Removes a createNewFolder event handler from the radfileexplorer
remove_createNewFolder
The event handler function to remove
Removes a delete event handler from the radfileexplorer
remove_delete
The event handler function to remove
Removes a eventHandlersAttached event handler from the radfileexplorer
remove_eventHandlersAttached
The event handler function to remove
Removes a fileOpen event handler from the radfileexplorer
remove_fileOpen
The event handler function to remove
Removes a folderChange event handler from the radfileexplorer
remove_folderChange
The event handler function to remove
Removes a folderLoaded event handler from the radfileexplorer
remove_folderLoaded
The event handler function to remove
Removes a init event handler from the radfileexplorer
remove_init
The event handler function to remove
Removes a itemSelected event handler from the radfileexplorer
remove_itemSelected
The event handler function to remove
Removes a load event handler from the radfileexplorer
remove_load
The event handler function to remove
Removes a move event handler from the radfileexplorer
remove_move
The event handler function to remove
Methods
Adds additional characters to the file name invalid characters list. Default list is ["\", "/", ":", "*", "?", """, "<", ">", "|"]
addFileNameInvalidChar(String char): void
The char to add to the file name invalid chars list
Attach/detach the event handlers
attachEventHandlers(Object toAttach): Object
Object
Shortcut method for set_dataSource(data); dataBind().
bindToData(Array data): Object
Object
Bind the data to the underlying bindable control
bindToServerData(Object serverData, Object pageIndex): Object
Object
Clears the copied items from the control state.
clearCopyItems(): void
Clears the filtering by reseting the filter and clearing the filter text box
clearFilter(): Object
Object
Clears the cached data on the browser
clearFolderCache(): void
Clear any item selection in the file list
clearSelection(): Object
Object
Filter the file list on the client only. Note that only the items displayed items will be filtered, i.e. paged content will filter only the current page
clientFilter(Object keyWord): Object
Object
Copies the selected items from the specified control.
copy(Telerik.Web.UI.FileExplorerControls fromControl): void
The control
Marks the provided items as copied. Only the provided items will be copied when the paste occurs.
copyItems(Array items): void
The items to copy
Marks the provided items as copied and appends them to the previously copied ones.
copyMoreItems(Array items): void
The items to copy
Create a FileExplorerItem from the provided path by looking at all file controls (tree or fileList)
createItemFromPath(String path): Telerik.Web.UI.FileExplorerItem
The path of the file
Returns:Telerik.Web.UI.FileExplorerItem
The found item
Creates a new directory. The path parameter should be a virtual path. In case that the second parameter is not specified a radprompt dialog appears and asks for the new name.
createNewDirectory(String path, String newName): void
The virtual path to the item
newNameStringBind the already provided data(use set_dataSource(data)) to the underlying bindable control
dataBind(): Object
Object
Deletes an item by its virtual path
deleteItem(String pathToItem, Boolean showConfirmDialog): void
The virtual path to the item
showConfirmDialogBooleanShow or not the confirmation dialog. If
Performs delete operation for all of the currently selected items on the Grid
deleteSelectedItems(Boolean showConfirmDialog): void
Show or not the confirmation dialog. If
Disposes the control. Does not dispose the underlying bindable control
dispose(): Object
Object
Filter the file list by the provided keyword. This method does not raise a filter event
doFiltering(Object keyWord): Object
Object
Filters the items in the currently selected directory.
filter(): void
Filter the file list by the provided keyword. This method raises a filter event
filterList(Object keyWord): Object
Object
Find a file by its name
findFileByName(Object fileName): Object
Object
Find a file by its path
findFileByPath(Object path): Object
Object
Focus the underlying control's DOM element
focus(): Object
Object
Focus the paging control of the file list
focusPagerControl(): Object
Object
Returns the ClientID of the input that shows the currently selected folder. Returns an empty string when the AddressBox is not visible
get_addressBox(): String
String
Returns a reference to the embedded RadAjaxLoadingPanel object
get_ajaxLoadingPanel(): Telerik.Web.UI.RadAjaxLoadingPanel
Telerik.Web.UI.RadAjaxLoadingPanel
Returns whether the Grid's paging is enabled
get_allowPaging(): Boolean
Boolean
Get a reference to the context menu that is utilized by the file list
get_contextMenu(): Object
Object
Get a reference to the underlying bindable control
get_control(): Object
Object
Returns a string value that represents the path to the currently selected directory. The returned path is a virtual path, such as "/RootProjectFolder/SelectedDir"
get_currentDirectory(): String
String
Returns the permissions set to the currently selected folder in the TreeView
get_currentPermissions(): Telerik.Web.UI.FileExplorerItemPermissions
Telerik.Web.UI.FileExplorerItemPermissions
Get the data source provided to the control
get_dataSource(): Array
Array
Gets the DOM element, where the file list resides.
get_element(): Element
Element
Returns whether a file can be opened for preview
get_enableOpenFile(): Boolean
Boolean
Gets the extension of the item - txt for example if it is a text file, ‘null’ when the selected item does not have extension(i.e. if the selected item is a folder)
get_extension(): void
Get a reference to the RadFileExplorer that used this instance of FileList
get_fileExplorer(): Object
Object
Returns a reference to the FileList object. Returns "null" when the FileList is not visible, i.e. only the RadTreeView is shown
get_fileList(): Telerik.Web.UI.FileExplorer.FileList
Telerik.Web.UI.FileExplorer.FileList
Returns a reference to the embedded RadGrid object. Returns "null" when the embedded Grid is not visible
get_grid(): Telerik.Web.UI.RadGrid
Telerik.Web.UI.RadGrid
Returns a reference to a RadMenu object. Returns "null" when the embedded grid is not visible
get_gridContextMenu(): Telerik.Web.UI.RadMenu
Telerik.Web.UI.RadMenu
Returns an object of type Telerik.Web.UI.FileExplorerItem
get_item(): void
Get the items displayed in the file list.
get_items(): Array
Array
Returns a reference to the embedded RadListView object. Returns "null" when the embedded ListView is not visible
get_listView(): Telerik.Web.UI.RadListView
Telerik.Web.UI.RadListView
Returns the name of the item
get_name(): void
Returns the default text that is shown in the CreateNewFolder dialog
get_newFolderDefaultValue(): String
String
When "Rename" is performed returns the new name of the item. When the "Move" is performed returns the new destination of the moved folder (see the OnClientMove example bellow)
get_newPath(): void
Get the page size as maximum number of items per page
get_pageSize(): Object
Object
Returns the virtual path to the item
get_path(): void
Returns the symbol used as path separator
get_pathSeparator(): String
String
Returns the applied current permissions to the item - enumerable value of type Telerik.Web.UI.FileExplorerItemPermissions
get_permissions(): void
Returns the first selected item on the Grid. Returns the selected item on the TreeView if there is no selected items in the Grid
get_selectedItem(): Telerik.Web.UI.FileExplorerItem
Telerik.Web.UI.FileExplorerItem
Returns an array of the selected items on the Grid. The items are of type Telerik.Web.UI.FileExplorerItem Returns the selected item on the TreeView if there is no selected items in the Grid
get_selectedItems(): Array
Array
Returns the size of the currently selected item. NaN if the selected item is a folder
get_size(): void
Returns a reference to the embedded RadToolBar object. Returns "null" when the embedded ToolBar is not visible
get_toolbar(): Telerik.Web.UI.RadToolBar
Telerik.Web.UI.RadToolBar
Returns a reference to the embedded RadTreeView object. Returns "null" when the embedded TreeView is not visible
get_tree(): Telerik.Web.UI.RadTreeView
Telerik.Web.UI.RadTreeView
Returns the type of the item – one of the enumerable values in the Telerik.Web.UI.FileExplorerItemType enumerable
get_type(): void
Has the same functionality as the get_path() function
get_url(): void
Returns a reference to the embedded RadWindowManager object
get_windowManager(): Telerik.Web.UI.RadWindowManager
Telerik.Web.UI.RadWindowManager
Gets the FileExplorerItem by the passed grid data item object
getFileExplorerItemFromGridDataItem(Telerik.Web.UI.GridDataItem item): Telerik.Web.UI.FileExplorerItem
A data item from the Grid
Returns:Telerik.Web.UI.FileExplorerItem
Gets the FileExplorerItem by the passed TreeNode object
getFileExplorerItemFromNode(Telerik.Web.UI.RadTreeNode node): Telerik.Web.UI.FileExplorerItem
A node from the TreeView
Returns:Telerik.Web.UI.FileExplorerItem
Get the selected files(Telerik.Web.UI.FileExplorerItem) from the file list
getSelectedFiles(): Array
Array
Returns a Boolean value that indicates whether the selected item is a folder or not
isDirectory(): void
Loads a new folder and sets the focus on it. The second parameter accepts a Boolean value that determines whether the current change of the directory to be stored in the Previous/Next stack
loadFolder(String path, Boolean addToStack): void
The path to the folder
addToStackBooleanIndicates whether the loaded path to be added to the Back
Opens a file
open(Telerik.Web.UI.FileExplorerItem currentItem): void
The item that will be opened. If the passed parameter is null then the currently selected item will be opened
Pastes the copied items into the provided destination directory
paste(Telerik.Web.UI.FileExplorerItem destinationDirectory): void
Refreshes the current folder
refresh(): void
Force a server call to collect the content of the folder
refreshFileList(Object folderPath): Object
Object
Removes items from the file name invalid characters list. Default list is ["\", "/", ":", "*", "?", """, "<", ">", "|"]
removeFileNameInvalidChar(String char): void
The char to remove from the file name invalid chars list
Renames the item with the new name
rename(Telerik.Web.UI.FileExplorerItem item, String newName): void
Try to select a default item from the file list. Usually this is the first item, or none if list is empty
selectDefaultFile(): Object
Object
Select an item from the file list
selectFile(Object file): Object
Object
Select a file item from the file list by the provided name
selectFileByName(Object fileName): Object
Object
Select a list of files by their names
selectFileList(Array fileNames): Object
Object
Force the server to do the filtering
serverFilter(Object keyWord): Object
Object
Changes the currently selected directory
set_currentDirectory(String value, Boolean addToStack): void
The new path
addToStackBooleanDetermines whether the current change of the directory to be stored in the Previous ï
Set the data needed for the data bindable control
set_dataSource(Array data): Object
Object
Sets whether a file can be opened for preview
set_enableOpenFile(Boolean value): void
Sets the default text that will be shown in the CreateNewFolder dialog
set_newFolderDefaultValue(String newDefaultName): void
Set the size of the page, i.e. the maximum number of items per page
set_pageSize(Object value): Object
Object
Show the content of a folder. This method takes advantage of a cached folder content, if the folder has already been loaded
showFolderFileList(Object folderPath): Object
Object
Show the content of a particular page
showPageContent(Object startIndex, Object pageSize): Object
Object
Sort the file list
sort(Object sortExpression): Object
Object