Interface for a class FileManager
This event is triggered before the deletion of a file or folder occurs. It can be utilized to prevent the deletion of specific files or folders. Any actions, such as displaying a spinner for deletion, can be implemented here.
EmitType<BeforeDownloadEventArgs>
Triggers before sending the download request to the server.
EmitType<FolderCreateEventArgs>
This event is triggered before a folder is created. It allows for the restriction of folder creation based on the application’s use case.
EmitType<BeforeImageLoadEventArgs>
Triggers before sending the getImage request to the server.
This event is triggered when a file or folder begins to move from its current path through a copy/cut and paste action.
EmitType<BeforePopupOpenCloseEventArgs>
Triggers before the dialog is closed.
EmitType<BeforePopupOpenCloseEventArgs>
Triggers before the dialog is opened.
This event is triggered when a file or folder is about to be renamed. It allows for the restriction of the rename action for specific folders or files by utilizing the cancel option.
Triggers before sending the AJAX request to the server.
EmitType<Object>
Triggers when the file manager component is created.
This event is triggered after the file or folder is deleted successfully. The deleted file or folder details can be retrieved here. Additionally, custom elements’ visibility can be managed here based on the application’s use case.
EmitType<Object>
Triggers when the file manager component is destroyed.
Triggers when the AJAX request is failed.
Triggers when the file/folder dragging is started.
Triggers when the file/folder is about to be dropped at the target.
Triggers while dragging the file/folder.
Triggers when the file/folder is dropped.
Triggers before the file/folder is rendered.
Triggers before the file/folder is opened.
Triggers when the file/folder is selected/unselected.
EmitType<FileSelectionEventArgs>
Triggers before the file/folder is selected.
EmitType<FolderCreateEventArgs>
This event is triggered when a folder is successfully created. It provides an opportunity to retrieve details about the newly created folder.
Triggers when the context menu item is clicked.
Triggers before the context menu is closed.
Triggers before the context menu is opened.
This event is triggered when a file or folder is pasted into the destination path.
EmitType<PopupOpenCloseEventArgs>
Triggers when the dialog is closed.
EmitType<PopupOpenCloseEventArgs>
Triggers when the dialog is opened.
This event is triggered when a file or folder is successfully renamed. It provides an opportunity to fetch details about the renamed file.
This event is triggered when a search action occurs in the search bar of the File Manager component. It triggers each character entered in the input during the search process.
Triggers when the AJAX request is success.
EmitType<ToolbarClickEventArgs>
Triggers when the toolbar item is clicked.
EmitType<ToolbarCreateEventArgs>
Triggers before creating the toolbar.
EmitType<UploadListCreateArgs>
Triggers before rendering each file item in upload dialog box.
Specifies the AJAX settings of the file manager.
boolean
Enables or disables drag-and-drop of files.
boolean
Enables or disables the multiple files selection of the file manager.
Specifies the context menu settings of the file manager.
string
Specifies the root CSS class of the file manager that allows you to customize the appearance by overriding the styles.
Specifies the details view settings of the file manager.
boolean
Defines whether to allow the cross-scripting site or not.
boolean
Enables or disables persisting component’s state between page reloads. If enabled, the following APIs will persist:
view: Represents the previous view of the file manager.path: Represents the previous path of the file manager.selectedItems: Represents the previous selected items in the file manager. boolean
Gets or sets a value that indicates whether the File Manager allows multiple items selection with mouse dragging. Set this property to true to allow users to select multiple items with mouse drag as like file explorer. Hover over the files or folders and drag the mouse to select the required items.
boolean
Enable or disable rendering component in right to left direction.
boolean
Gets or sets a value that enables/disables the virtualization feature of the File Manager. When enabled, the File Manager will only load a subset of files and folders based on the size of the view port, with the rest being loaded dynamically as the user scrolls vertically through the list. This can improve performance when dealing with a large number of files and folders, as it reduces the initial load time and memory usage.
{ : }[]
Specifies the array of data to populate folders/files in the File Manager. The mandatory fields to be included in the JSON data are defined in fileData interface. This interface can be extended to add additional fields as required.
string | number
Specifies the height of the file manager.
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Specifies the navigationpane settings of the file manager.
string
Specifies the current path of the file manager.
HTMLElement | string
Specifies the target element in which the File Manager’s dialog will be displayed. The default value is null, which refers to the File Manager element.
string
Specifies the root folder alias name in file manager
Specifies the search settings of the file manager.
string[]
Specifies the selected folders and files name of the file manager.
boolean
Shows or hides the file extension in file manager.
boolean
Determines whether to show or hide hidden files and folders. This is applicable only for storage systems that support attributes for controlling the visibility of data, including physical file directories and custom flat data handlers.
boolean
Gets or sets a boolean value that determines whether to display checkboxes in the file manager. If enabled, checkboxes are shown for files or folders on hover.
boolean
Shows or hides the thumbnail images in largeicons view.
string
Specifies the field name being used as the sorting criteria to sort the files of the file manager component.
SortComparer | string
Defines the custom sorting function.
The sort comparer function has the same functionality like
Array.sort sort comparer.
This can be used to customize the default sorting functionalities with required comparison values.
SortOrder
Specifies a value that indicates whether the folders and files are sorted in the ascending or descending order,
or they are not sorted at all. The available types of sort orders are,
None - Indicates that the folders and files are not sorted.
Ascending - Indicates that the folders and files are sorted in the ascending order.
Descending - Indicates that the folders and files are sorted in the descending order.
An array of items that are used to configure File Manager toolbar items.
Specifies the group of items aligned horizontally in the toolbar.
Specifies the upload settings for the file manager.
ViewType
Specifies the initial view of the file manager. With the help of this property, initial view can be changed to details or largeicons view. The available views are:
LargeIconsDetails string | number
Specifies the width of the file manager.