Class FileManager
Inherited Members
Namespace: Syncfusion.EJ2.FileManager
Assembly: Syncfusion.EJ2.dll
Syntax
public class FileManager : EJTagHelper
Constructors
FileManager()
Declaration
public FileManager()
Properties
AjaxSettings
Specifies the AJAX settings of the file manager.
Declaration
[HtmlAttributeName("ajaxSettings")]
public FileManagerAjaxSettings AjaxSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerAjaxSettings | The default value is null |
AllowDragAndDrop
Enables or disables drag-and-drop of files.
Declaration
[HtmlAttributeName("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowMultiSelection
Enables or disables the multiple files selection of the file manager.
Declaration
[HtmlAttributeName("allowMultiSelection")]
public bool AllowMultiSelection { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
BeforeDownload
Triggers before sending the download request to the server.
Declaration
[HtmlAttributeName("beforeDownload")]
public string BeforeDownload { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeImageLoad
Triggers before sending the getImage request to the server.
Declaration
[HtmlAttributeName("beforeImageLoad")]
public string BeforeImageLoad { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePopupClose
Triggers before the dialog is closed.
Declaration
[HtmlAttributeName("beforePopupClose")]
public string BeforePopupClose { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePopupOpen
Triggers before the dialog is opened.
Declaration
[HtmlAttributeName("beforePopupOpen")]
public string BeforePopupOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeSend
Triggers before sending the AJAX request to the server.
Declaration
[HtmlAttributeName("beforeSend")]
public string BeforeSend { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ContextMenuSettings
Specifies the context menu settings of the file manager.
Declaration
[HtmlAttributeName("contextMenuSettings")]
public FileManagerContextMenuSettings ContextMenuSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerContextMenuSettings | The default value is null |
Created
Triggers when the file manager component is created.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CssClass
Specifies the root CSS class of the file manager that allows you to customize the appearance by overriding the styles.
Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Destroyed
Triggers when the file manager component is destroyed.
Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DetailsViewSettings
Specifies the details view settings of the file manager.
Declaration
[HtmlAttributeName("detailsViewSettings")]
public FileManagerDetailsViewSettings DetailsViewSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerDetailsViewSettings | The default value is null |
EnableHtmlSanitizer
Defines whether to allow the cross-scripting site or not.
Declaration
[HtmlAttributeName("enableHtmlSanitizer")]
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnablePersistence
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.
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableVirtualization
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.
Declaration
[HtmlAttributeName("enableVirtualization")]
public bool EnableVirtualization { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Failure
Triggers when the AJAX request is failed.
Declaration
[HtmlAttributeName("failure")]
public string Failure { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileDragging
Triggers while dragging the file/folder.
Declaration
[HtmlAttributeName("fileDragging")]
public string FileDragging { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileDragStart
Triggers when the file/folder dragging is started.
Declaration
[HtmlAttributeName("fileDragStart")]
public string FileDragStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileDragStop
Triggers when the file/folder is about to be dropped at the target.
Declaration
[HtmlAttributeName("fileDragStop")]
public string FileDragStop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileDropped
Triggers when the file/folder is dropped.
Declaration
[HtmlAttributeName("fileDropped")]
public string FileDropped { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileLoad
Triggers before the file/folder is rendered.
Declaration
[HtmlAttributeName("fileLoad")]
public string FileLoad { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileOpen
Triggers before the file/folder is opened.
Declaration
[HtmlAttributeName("fileOpen")]
public string FileOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileSelect
Triggers when the file/folder is selected/unselected.
Declaration
[HtmlAttributeName("fileSelect")]
public string FileSelect { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileSelection
Triggers before the file/folder is selected.
Declaration
[HtmlAttributeName("fileSelection")]
public string FileSelection { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Height
Specifies the height of the file manager.
Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "400px" |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
MenuClick
Triggers when the context menu item is clicked.
Declaration
[HtmlAttributeName("menuClick")]
public string MenuClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
MenuOpen
Triggers before the context menu is opened.
Declaration
[HtmlAttributeName("menuOpen")]
public string MenuOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
NavigationPaneSettings
Specifies the navigationpane settings of the file manager.
Declaration
[HtmlAttributeName("navigationPaneSettings")]
public FileManagerNavigationPaneSettings NavigationPaneSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerNavigationPaneSettings | The default value is null |
Path
Specifies the current path of the file manager.
Declaration
[HtmlAttributeName("path")]
public string Path { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "/" |
PopupClose
Triggers when the dialog is closed.
Declaration
[HtmlAttributeName("popupClose")]
public string PopupClose { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PopupOpen
Triggers when the dialog is opened.
Declaration
[HtmlAttributeName("popupOpen")]
public string PopupOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PopupTarget
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.
Declaration
[HtmlAttributeName("popupTarget")]
public string PopupTarget { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RootAliasName
Specifies the root folder alias name in file manager
Declaration
[HtmlAttributeName("rootAliasName")]
public string RootAliasName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SearchSettings
Specifies the search settings of the file manager.
Declaration
[HtmlAttributeName("searchSettings")]
public FileManagerSearchSettings SearchSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerSearchSettings | The default value is null |
SelectedItems
Specifies the selected folders and files name of the file manager.
Declaration
[HtmlAttributeName("selectedItems")]
public string[] SelectedItems { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
ShowFileExtension
Shows or hides the file extension in file manager.
Declaration
[HtmlAttributeName("showFileExtension")]
public bool ShowFileExtension { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ShowHiddenItems
Shows or hides the files and folders that are marked as hidden.
Declaration
[HtmlAttributeName("showHiddenItems")]
public bool ShowHiddenItems { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
ShowThumbnail
Shows or hides the thumbnail images in largeicons view.
Declaration
[HtmlAttributeName("showThumbnail")]
public bool ShowThumbnail { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
SortBy
Specifies the field name being used as the sorting criteria to sort the files of the file manager component.
Declaration
[HtmlAttributeName("sortBy")]
public string SortBy { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "name" |
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.
Declaration
[HtmlAttributeName("sortOrder")]
public SortOrder SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder | The default value is SortOrder.Ascending |
Success
Triggers when the AJAX request is success.
Declaration
[HtmlAttributeName("success")]
public string Success { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ToolbarClick
Triggers when the toolbar item is clicked.
Declaration
[HtmlAttributeName("toolbarClick")]
public string ToolbarClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ToolbarCreate
Triggers before creating the toolbar.
Declaration
[HtmlAttributeName("toolbarCreate")]
public string ToolbarCreate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ToolbarSettings
Specifies the group of items aligned horizontally in the toolbar.
Declaration
[HtmlAttributeName("toolbarSettings")]
public FileManagerToolbarSettings ToolbarSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerToolbarSettings | The default value is null |
UploadListCreate
Triggers before rendering each file item in upload dialog box.
Declaration
[HtmlAttributeName("uploadListCreate")]
public string UploadListCreate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
UploadSettings
Specifies the upload settings for the file manager.
Declaration
[HtmlAttributeName("uploadSettings")]
public FileManagerUploadSettings UploadSettings { get; set; }
Property Value
Type | Description |
---|---|
FileManagerUploadSettings | The default value is null |
View
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:
LargeIcons
Details
Declaration
[HtmlAttributeName("view")]
public ViewType View { get; set; }
Property Value
Type | Description |
---|---|
ViewType | The default value is ViewType.LargeIcons |
Width
Specifies the width of the file manager.
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |