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

Definition

Namespace:Telerik.Web.UI.FileExplorer

Inheritance: Sys.ComponentTelerik.Web.UI.FileExplorer.FileList

Methods

Attach/detach the event handlers

JS
attachEventHandlers(Boolean toAttach): void
Parameters:toAttachBoolean

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

JS
bindToData(Array data): void
Parameters:dataArray

The array of elements to bind to

Bind the data to the underlying bindable control

JS
bindToServerData(Object serverData, Number pageIndex): void
Parameters:serverDataObject

The data provided by the server callback or from cached location. Should follow the format of the Telerik.Web.UI.FileExplorer.ServerData

pageIndexNumber

The page

Chooses the view with the specified name. The view is displayed and the currently displayed one is hidden

JS
chooseFileListView(String name): void
Parameters:nameString

The name of the view to display.

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

JS
clearFilter(): void

Clears the caching of the specified folder, forcing a reload the next time this folder's content is loaded

JS
clearFolderCache(String path): void
Parameters:pathString

The path to the folder

Clear any item selection in the file list

JS
clearSelection(): void

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(String keyWord): void
Parameters:keyWordString

Filter keyword

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

JS
dataBind(): void

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

JS
doFiltering(String keyWord): void
Parameters:keyWordString

Filter keyword

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

JS
filterList(String keyWord): void
Parameters:keyWordString

Filter keyword

Find a file by its name

JS
findFileByName(String fileName): Telerik.Web.UI.FileExplorer.FileDataItem
Parameters:fileNameString

Name of a file

Returns:

Telerik.Web.UI.FileExplorer.FileDataItem

Searched Item

Find a file by its path

JS
findFileByPath(String path): Telerik.Web.UI.FileExplorer.FileDataItem
Parameters:pathString

Path to a file

Returns:

Telerik.Web.UI.FileExplorer.FileDataItem

Searched Item

Focus the underlying control's DOM element

JS
focus(): void

Focus the paging control of the file list

JS
focusPagerControl(): void

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

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

Telerik.Web.UI.RadMenu

Get a reference to the underlying file list view

JS
get_control(): Telerik.Web.UI.FileExplorer.IFileListView
Returns:

Telerik.Web.UI.FileExplorer.IFileListView

Get the data source provided to the control

JS
get_dataSource(): Array
Returns:

Array

The data object provided to the control

Gets the DOM element, where the file list resides.

JS
get_element(): Element
Returns:

Element

The DOM element of the underlying control

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

JS
get_fileExplorer(): Telerik.Web.UI.RadFileExplorer
Returns:

Telerik.Web.UI.RadFileExplorer

Gets a reference to the filter text box DOM element that resides in the current file list view

JS
get_filterTextBox(Telerik.Web.UI.FileExplorer.IFileListView view): Object
Parameters:viewTelerik.Web.UI.FileExplorer.IFileListView

The view where to look for the filter text box. If the view is not provided

Returns:

Object

The input element of the filter text box

Get a reference to the grid control that displays the list of files if such is being used to display the items

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

Telerik.Web.UI.RadGrid

The RadGrid managing the file list

Get the items displayed in the file list.

JS
get_items(): Array
Returns:

Array

All items array

Get a reference to the list view control that displays the list of files if such is being used to display the items

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

Telerik.Web.UI.RadListView

The RadListView managing the file list

Get the page size as maximum number of items per page

JS
get_pageSize(): Number
Returns:

Number

The page size

Get the first selected item from the file list

JS
get_selectedItem(): Telerik.Web.UI.FileExplorer.FileDataItem
Returns:

Telerik.Web.UI.FileExplorer.FileDataItem

Selected item

Get the selected items from the file list

JS
get_selectedItems(): Array
Returns:

Array

Selected items array

Get a reference to the underlying file list view

JS
get_view(): Telerik.Web.UI.FileExplorer.IFileListView
Returns:

Telerik.Web.UI.FileExplorer.IFileListView

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

JS
getSelectedFiles(): Array
Returns:

Array

Selected files

Open the corresponding file item. If directory, the explorer navigates to it and displays its content

JS
open(Telerik.Web.UI.FileExplorerItem item): void
Parameters:itemTelerik.Web.UI.FileExplorerItem

The item to open. Can be either Telerik.Web.UI.FileExlorerItem

Force a server call to collect the content of the folder

JS
refreshFileList(String folderPath): void
Parameters:folderPathString

The path to the folder

Registers a view in the file list container. This is the way to make it available later as an chosen/active file list view

JS
registerFileListView(Telerik.Web.UI.FileExplorer.IFileListView view): void
Parameters:viewTelerik.Web.UI.FileExplorer.IFileListView

The view to be registered for use. Can be chosen later by name.

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

JS
selectDefaultFile(): void

Select an item from the file list

JS
selectFile(Telerik.Web.UI.FileExplorer.FileDataItem file): void
Parameters:fileTelerik.Web.UI.FileExplorer.FileDataItem

The file could be either Telerik.Web.UI.FileDataItem

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

JS
selectFileByName(String fileName): void
Parameters:fileNameString

The name of the file to select

Select a list of files by their names

JS
selectFileList(Array fileNames): void
Parameters:fileNamesArray

An array of file names to select

Force the server to do the filtering.

JS
serverFilter(String keyWord): void
Parameters:keyWordString

Filter keyword

Set the data needed for the data bindable control

JS
set_dataSource(Array data): void
Parameters:dataArray

Sets the data for the underlying data bindable control

Set the height of the FileList. This will call set_height of all the FileListViews

JS
set_height(String height): void
Parameters:heightString

The height to be set.

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

JS
set_pageSize(Number value): void
Parameters:valueNumber

New page size

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

JS
showFolderFileList(String folderPath): void
Parameters:folderPathString

The path to the folder

Show the content of a particular page

JS
showPageContent(Number startIndex, Number pageSize): void
Parameters:startIndexNumber

The index

pageSizeNumber

A custom page size. Default behavior is to use the page size of the file list

Sort the file list

JS
sort(String sortExpression): void
Parameters:sortExpressionString

Sorting expression. E.g.

Not finding the help you need?
Contact Support