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