New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Definition

Namespace:Telerik.Web.UI

Inheritance: Telerik.Web.UI.RadWebControlTelerik.Web.UI.RadFileExplorer

Events

Adds a ajaxRequestEnd event handler for the radfileexplorer

JS
add_ajaxRequestEnd
Parameters:handlerFunction

The event handler function to attach

Adds a ajaxRequestStart event handler for the radfileexplorer

JS
add_ajaxRequestStart
Parameters:handlerFunction

The event handler function to attach

Adds a copy event handler for the radfileexplorer

JS
add_copy
Parameters:handlerFunction

The event handler function to attach

Adds a createNewFolder event handler for the radfileexplorer

JS
add_createNewFolder
Parameters:handlerFunction

The event handler function to attach

Adds a delete event handler for the radfileexplorer

JS
add_delete
Parameters:handlerFunction

The event handler function to attach

Adds a eventHandlersAttached event handler for the radfileexplorer

JS
add_eventHandlersAttached
Parameters:handlerFunction

The event handler function to attach

Adds a fileOpen event handler for the radfileexplorer

JS
add_fileOpen
Parameters:handlerFunction

The event handler function to attach

Adds a folderChange event handler for the radfileexplorer

JS
add_folderChange
Parameters:handlerFunction

The event handler function to attach

Adds a folderLoaded event handler for the radfileexplorer

JS
add_folderLoaded
Parameters:handlerFunction

The event handler function to attach

Adds a init event handler for the radfileexplorer

JS
add_init
Parameters:handlerFunction

The event handler function to attach

Adds a itemSelected event handler for the radfileexplorer

JS
add_itemSelected
Parameters:handlerFunction

The event handler function to attach

Adds a load event handler for the radfileexplorer

JS
add_load
Parameters:handlerFunction

The event handler function to attach

Adds a move event handler for the radfileexplorer

JS
add_move
Parameters:handlerFunction

The event handler function to attach

Removes a ajaxRequestEnd event handler from the radfileexplorer

JS
remove_ajaxRequestEnd
Parameters:handlerFunction

The event handler function to remove

Removes a ajaxRequestStart event handler from the radfileexplorer

JS
remove_ajaxRequestStart
Parameters:handlerFunction

The event handler function to remove

Removes a copy event handler from the radfileexplorer

JS
remove_copy
Parameters:handlerFunction

The event handler function to remove

Removes a createNewFolder event handler from the radfileexplorer

JS
remove_createNewFolder
Parameters:handlerFunction

The event handler function to remove

Removes a delete event handler from the radfileexplorer

JS
remove_delete
Parameters:handlerFunction

The event handler function to remove

Removes a eventHandlersAttached event handler from the radfileexplorer

JS
remove_eventHandlersAttached
Parameters:handlerFunction

The event handler function to remove

Removes a fileOpen event handler from the radfileexplorer

JS
remove_fileOpen
Parameters:handlerFunction

The event handler function to remove

Removes a folderChange event handler from the radfileexplorer

JS
remove_folderChange
Parameters:handlerFunction

The event handler function to remove

Removes a folderLoaded event handler from the radfileexplorer

JS
remove_folderLoaded
Parameters:handlerFunction

The event handler function to remove

Removes a init event handler from the radfileexplorer

JS
remove_init
Parameters:handlerFunction

The event handler function to remove

Removes a itemSelected event handler from the radfileexplorer

JS
remove_itemSelected
Parameters:handlerFunction

The event handler function to remove

Removes a load event handler from the radfileexplorer

JS
remove_load
Parameters:handlerFunction

The event handler function to remove

Removes a move event handler from the radfileexplorer

JS
remove_move
Parameters:handlerFunction

The event handler function to remove

Methods

Adds additional characters to the file name invalid characters list. Default list is ["\", "/", ":", "*", "?", """, "<", ">", "|"]

JS
addFileNameInvalidChar(String char): void
Parameters:charString

The char to add to the file name invalid chars list

Attach/detach the event handlers

JS
attachEventHandlers(Object toAttach): Object
Parameters:toAttachObjectReturns:

Object

Shortcut method for set_dataSource(data); dataBind().

JS
bindToData(Array data): Object
Parameters:dataArrayReturns:

Object

Bind the data to the underlying bindable control

JS
bindToServerData(Object serverData, Object pageIndex): Object
Parameters:serverDataObjectpageIndexObjectReturns:

Object

Clears the copied items from the control state.

JS
clearCopyItems(): void

Clears the filtering by reseting the filter and clearing the filter text box

JS
clearFilter(): Object
Returns:

Object

Clears the cached data on the browser

JS
clearFolderCache(): void

Clear any item selection in the file list

JS
clearSelection(): Object
Returns:

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

JS
clientFilter(Object keyWord): Object
Parameters:keyWordObjectReturns:

Object

Copies the selected items from the specified control.

JS
copy(Telerik.Web.UI.FileExplorerControls fromControl): void
Parameters:fromControlTelerik.Web.UI.FileExplorerControls

The control

Marks the provided items as copied. Only the provided items will be copied when the paste occurs.

JS
copyItems(Array items): void
Parameters:itemsArray

The items to copy

Marks the provided items as copied and appends them to the previously copied ones.

JS
copyMoreItems(Array items): void
Parameters:itemsArray

The items to copy

Create a FileExplorerItem from the provided path by looking at all file controls (tree or fileList)

JS
createItemFromPath(String path): Telerik.Web.UI.FileExplorerItem
Parameters:pathString

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.

JS
createNewDirectory(String path, String newName): void
Parameters:pathString

The virtual path to the item

newNameString

Bind the already provided data(use set_dataSource(data)) to the underlying bindable control

JS
dataBind(): Object
Returns:

Object

Deletes an item by its virtual path

JS
deleteItem(String pathToItem, Boolean showConfirmDialog): void
Parameters:pathToItemString

The virtual path to the item

showConfirmDialogBoolean

Show or not the confirmation dialog. If

Performs delete operation for all of the currently selected items on the Grid

JS
deleteSelectedItems(Boolean showConfirmDialog): void
Parameters:showConfirmDialogBoolean

Show or not the confirmation dialog. If

Disposes the control. Does not dispose the underlying bindable control

JS
dispose(): Object
Returns:

Object

Filter the file list by the provided keyword. This method does not raise a filter event

JS
doFiltering(Object keyWord): Object
Parameters:keyWordObjectReturns:

Object

Filters the items in the currently selected directory.

JS
filter(): void

Filter the file list by the provided keyword. This method raises a filter event

JS
filterList(Object keyWord): Object
Parameters:keyWordObjectReturns:

Object

Find a file by its name

JS
findFileByName(Object fileName): Object
Parameters:fileNameObjectReturns:

Object

Find a file by its path

JS
findFileByPath(Object path): Object
Parameters:pathObjectReturns:

Object

Focus the underlying control's DOM element

JS
focus(): Object
Returns:

Object

Focus the paging control of the file list

JS
focusPagerControl(): Object
Returns:

Object

Returns the ClientID of the input that shows the currently selected folder. Returns an empty string when the AddressBox is not visible

JS
get_addressBox(): String
Returns:

String

Returns a reference to the embedded RadAjaxLoadingPanel object

JS
get_ajaxLoadingPanel(): Telerik.Web.UI.RadAjaxLoadingPanel
Returns:

Telerik.Web.UI.RadAjaxLoadingPanel

Returns whether the Grid's paging is enabled

JS
get_allowPaging(): Boolean
Returns:

Boolean

Get a reference to the context menu that is utilized by the file list

JS
get_contextMenu(): Object
Returns:

Object

Get a reference to the underlying bindable control

JS
get_control(): Object
Returns:

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"

JS
get_currentDirectory(): String
Returns:

String

Returns the permissions set to the currently selected folder in the TreeView

JS
get_currentPermissions(): Telerik.Web.UI.FileExplorerItemPermissions
Returns:

Telerik.Web.UI.FileExplorerItemPermissions

Get the data source provided to the control

JS
get_dataSource(): Array
Returns:

Array

Gets the DOM element, where the file list resides.

JS
get_element(): Element
Returns:

Element

Returns whether a file can be opened for preview

JS
get_enableOpenFile(): Boolean
Returns:

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)

JS
get_extension(): void

Get a reference to the RadFileExplorer that used this instance of FileList

JS
get_fileExplorer(): Object
Returns:

Object

Returns a reference to the FileList object. Returns "null" when the FileList is not visible, i.e. only the RadTreeView is shown

JS
get_fileList(): Telerik.Web.UI.FileExplorer.FileList
Returns:

Telerik.Web.UI.FileExplorer.FileList

Returns a reference to the embedded RadGrid object. Returns "null" when the embedded Grid is not visible

JS
get_grid(): Telerik.Web.UI.RadGrid
Returns:

Telerik.Web.UI.RadGrid

Returns a reference to a RadMenu object. Returns "null" when the embedded grid is not visible

JS
get_gridContextMenu(): Telerik.Web.UI.RadMenu
Returns:

Telerik.Web.UI.RadMenu

Returns an object of type Telerik.Web.UI.FileExplorerItem

JS
get_item(): void

Get the items displayed in the file list.

JS
get_items(): Array
Returns:

Array

Returns a reference to the embedded RadListView object. Returns "null" when the embedded ListView is not visible

JS
get_listView(): Telerik.Web.UI.RadListView
Returns:

Telerik.Web.UI.RadListView

Returns the name of the item

JS
get_name(): void

Returns the default text that is shown in the CreateNewFolder dialog

JS
get_newFolderDefaultValue(): String
Returns:

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)

JS
get_newPath(): void

Get the page size as maximum number of items per page

JS
get_pageSize(): Object
Returns:

Object

Returns the virtual path to the item

JS
get_path(): void

Returns the symbol used as path separator

JS
get_pathSeparator(): String
Returns:

String

Returns the applied current permissions to the item - enumerable value of type Telerik.Web.UI.FileExplorerItemPermissions

JS
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

JS
get_selectedItem(): Telerik.Web.UI.FileExplorerItem
Returns:

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

JS
get_selectedItems(): Array
Returns:

Array

Returns the size of the currently selected item. NaN if the selected item is a folder

JS
get_size(): void

Returns a reference to the embedded RadToolBar object. Returns "null" when the embedded ToolBar is not visible

JS
get_toolbar(): Telerik.Web.UI.RadToolBar
Returns:

Telerik.Web.UI.RadToolBar

Returns a reference to the embedded RadTreeView object. Returns "null" when the embedded TreeView is not visible

JS
get_tree(): Telerik.Web.UI.RadTreeView
Returns:

Telerik.Web.UI.RadTreeView

Returns the type of the item – one of the enumerable values in the Telerik.Web.UI.FileExplorerItemType enumerable

JS
get_type(): void

Has the same functionality as the get_path() function

JS
get_url(): void

Returns a reference to the embedded RadWindowManager object

JS
get_windowManager(): Telerik.Web.UI.RadWindowManager
Returns:

Telerik.Web.UI.RadWindowManager

Gets the FileExplorerItem by the passed grid data item object

JS
getFileExplorerItemFromGridDataItem(Telerik.Web.UI.GridDataItem item): Telerik.Web.UI.FileExplorerItem
Parameters:itemTelerik.Web.UI.GridDataItem

A data item from the Grid

Returns:

Telerik.Web.UI.FileExplorerItem

Gets the FileExplorerItem by the passed TreeNode object

JS
getFileExplorerItemFromNode(Telerik.Web.UI.RadTreeNode node): Telerik.Web.UI.FileExplorerItem
Parameters:nodeTelerik.Web.UI.RadTreeNode

A node from the TreeView

Returns:

Telerik.Web.UI.FileExplorerItem

Get the selected files(Telerik.Web.UI.FileExplorerItem) from the file list

JS
getSelectedFiles(): Array
Returns:

Array

Returns a Boolean value that indicates whether the selected item is a folder or not

JS
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

JS
loadFolder(String path, Boolean addToStack): void
Parameters:pathString

The path to the folder

addToStackBoolean

Indicates whether the loaded path to be added to the Back

Opens a file

JS
open(Telerik.Web.UI.FileExplorerItem currentItem): void
Parameters:currentItemTelerik.Web.UI.FileExplorerItem

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

JS
paste(Telerik.Web.UI.FileExplorerItem destinationDirectory): void
Parameters:destinationDirectoryTelerik.Web.UI.FileExplorerItem

Refreshes the current folder

JS
refresh(): void

Force a server call to collect the content of the folder

JS
refreshFileList(Object folderPath): Object
Parameters:folderPathObjectReturns:

Object

Removes items from the file name invalid characters list. Default list is ["\", "/", ":", "*", "?", """, "<", ">", "|"]

JS
removeFileNameInvalidChar(String char): void
Parameters:charString

The char to remove from the file name invalid chars list

Renames the item with the new name

JS
rename(Telerik.Web.UI.FileExplorerItem item, String newName): void
Parameters:itemTelerik.Web.UI.FileExplorerItemnewNameString

Try to select a default item from the file list. Usually this is the first item, or none if list is empty

JS
selectDefaultFile(): Object
Returns:

Object

Select an item from the file list

JS
selectFile(Object file): Object
Parameters:fileObjectReturns:

Object

Select a file item from the file list by the provided name

JS
selectFileByName(Object fileName): Object
Parameters:fileNameObjectReturns:

Object

Select a list of files by their names

JS
selectFileList(Array fileNames): Object
Parameters:fileNamesArrayReturns:

Object

Force the server to do the filtering

JS
serverFilter(Object keyWord): Object
Parameters:keyWordObjectReturns:

Object

Changes the currently selected directory

JS
set_currentDirectory(String value, Boolean addToStack): void
Parameters:valueString

The new path

addToStackBoolean

Determines whether the current change of the directory to be stored in the Previous ï

Set the data needed for the data bindable control

JS
set_dataSource(Array data): Object
Parameters:dataArrayReturns:

Object

Sets whether a file can be opened for preview

JS
set_enableOpenFile(Boolean value): void
Parameters:valueBoolean

Sets the default text that will be shown in the CreateNewFolder dialog

JS
set_newFolderDefaultValue(String newDefaultName): void
Parameters:newDefaultNameString

Set the size of the page, i.e. the maximum number of items per page

JS
set_pageSize(Object value): Object
Parameters:valueObjectReturns:

Object

Show the content of a folder. This method takes advantage of a cached folder content, if the folder has already been loaded

JS
showFolderFileList(Object folderPath): Object
Parameters:folderPathObjectReturns:

Object

Show the content of a particular page

JS
showPageContent(Object startIndex, Object pageSize): Object
Parameters:startIndexObjectpageSizeObjectReturns:

Object

Sort the file list

JS
sort(Object sortExpression): Object
Parameters:sortExpressionObjectReturns:

Object

Not finding the help you need?
Contact Support