ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class FileManagerBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class FileManagerBuilder

    Inheritance
    System.Object
    ControlBuilder
    FileManagerBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.FileManager
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class FileManagerBuilder : ControlBuilder

    Constructors

    FileManagerBuilder()

    Declaration
    public FileManagerBuilder()

    FileManagerBuilder(FileManager)

    Declaration
    public FileManagerBuilder(FileManager model)
    Parameters
    Type Name Description
    FileManager model

    Fields

    model

    Declaration
    public FileManager model
    Field Value
    Type Description
    FileManager

    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
    ControlBuilder.Output

    Methods

    AjaxSettings(FileManagerAjaxSettings)

    Specifies the AJAX settings of the file manager.

    Declaration
    public FileManagerBuilder AjaxSettings(FileManagerAjaxSettings ajaxSettings)
    Parameters
    Type Name Description
    FileManagerAjaxSettings ajaxSettings
    Returns
    Type Description
    FileManagerBuilder

    AjaxSettings(Action<FileManagerAjaxSettingsBuilder>)

    Declaration
    public FileManagerBuilder AjaxSettings(Action<FileManagerAjaxSettingsBuilder> ajaxSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerAjaxSettingsBuilder> ajaxSettings
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    BeforePopupClose(String)

    Triggers before the dialog is closed.

    Declaration
    public FileManagerBuilder BeforePopupClose(string beforePopupClose)
    Parameters
    Type Name Description
    System.String beforePopupClose
    Returns
    Type Description
    FileManagerBuilder

    BeforePopupOpen(String)

    Triggers before the dialog is opened.

    Declaration
    public FileManagerBuilder BeforePopupOpen(string beforePopupOpen)
    Parameters
    Type Name Description
    System.String beforePopupOpen
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    ContextMenuSettings(FileManagerContextMenuSettings)

    Specifies the context menu settings of the file manager.

    Declaration
    public FileManagerBuilder ContextMenuSettings(FileManagerContextMenuSettings contextMenuSettings)
    Parameters
    Type Name Description
    FileManagerContextMenuSettings contextMenuSettings
    Returns
    Type Description
    FileManagerBuilder

    ContextMenuSettings(Action<FileManagerContextMenuSettingsBuilder>)

    Declaration
    public FileManagerBuilder ContextMenuSettings(Action<FileManagerContextMenuSettingsBuilder> contextMenuSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerContextMenuSettingsBuilder> contextMenuSettings
    Returns
    Type Description
    FileManagerBuilder

    Created(String)

    Triggers when the file manager component is created.

    Declaration
    public FileManagerBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    Destroyed(String)

    Triggers when the file manager component is destroyed.

    Declaration
    public FileManagerBuilder Destroyed(string destroyed)
    Parameters
    Type Name Description
    System.String destroyed
    Returns
    Type Description
    FileManagerBuilder

    DetailsViewSettings(FileManagerDetailsViewSettings)

    Specifies the details view settings of the file manager.

    Declaration
    public FileManagerBuilder DetailsViewSettings(FileManagerDetailsViewSettings detailsViewSettings)
    Parameters
    Type Name Description
    FileManagerDetailsViewSettings detailsViewSettings
    Returns
    Type Description
    FileManagerBuilder

    DetailsViewSettings(Action<FileManagerDetailsViewSettingsBuilder>)

    Declaration
    public FileManagerBuilder DetailsViewSettings(Action<FileManagerDetailsViewSettingsBuilder> detailsViewSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerDetailsViewSettingsBuilder> detailsViewSettings
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    EnablePersistence(Boolean)

    Enables or disables persisting component's state between page reloads. If enabled, the following APIs will persist:

    1. view: Represents the previous view of the file manager.
    2. path: Represents the previous path of the file manager.
    3. 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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    Failure(String)

    Triggers when the AJAX request is failed.

    Declaration
    public FileManagerBuilder Failure(string failure)
    Parameters
    Type Name Description
    System.String failure
    Returns
    Type Description
    FileManagerBuilder

    FileDragging(String)

    Triggers while dragging the file/folder.

    Declaration
    public FileManagerBuilder FileDragging(string fileDragging)
    Parameters
    Type Name Description
    System.String fileDragging
    Returns
    Type Description
    FileManagerBuilder

    FileDragStart(String)

    Triggers when the file/folder dragging is started.

    Declaration
    public FileManagerBuilder FileDragStart(string fileDragStart)
    Parameters
    Type Name Description
    System.String fileDragStart
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    FileDropped(String)

    Triggers when the file/folder is dropped.

    Declaration
    public FileManagerBuilder FileDropped(string fileDropped)
    Parameters
    Type Name Description
    System.String fileDropped
    Returns
    Type Description
    FileManagerBuilder

    FileLoad(String)

    Triggers before the file/folder is rendered.

    Declaration
    public FileManagerBuilder FileLoad(string fileLoad)
    Parameters
    Type Name Description
    System.String fileLoad
    Returns
    Type Description
    FileManagerBuilder

    FileOpen(String)

    Triggers before the file/folder is opened.

    Declaration
    public FileManagerBuilder FileOpen(string fileOpen)
    Parameters
    Type Name Description
    System.String fileOpen
    Returns
    Type Description
    FileManagerBuilder

    FileSelect(String)

    Triggers when the file/folder is selected/unselected.

    Declaration
    public FileManagerBuilder FileSelect(string fileSelect)
    Parameters
    Type Name Description
    System.String fileSelect
    Returns
    Type Description
    FileManagerBuilder

    FileSelection(String)

    Triggers before the file/folder is selected.

    Declaration
    public FileManagerBuilder FileSelection(string fileSelection)
    Parameters
    Type Name Description
    System.String fileSelection
    Returns
    Type Description
    FileManagerBuilder

    Height(Double)

    Specifies the height of the file manager.

    Declaration
    public FileManagerBuilder Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    FileManagerBuilder

    Height(String)

    Specifies the height of the file manager.

    Declaration
    public FileManagerBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    MenuClick(String)

    Triggers when the context menu item is clicked.

    Declaration
    public FileManagerBuilder MenuClick(string menuClick)
    Parameters
    Type Name Description
    System.String menuClick
    Returns
    Type Description
    FileManagerBuilder

    MenuOpen(String)

    Triggers before the context menu is opened.

    Declaration
    public FileManagerBuilder MenuOpen(string menuOpen)
    Parameters
    Type Name Description
    System.String menuOpen
    Returns
    Type Description
    FileManagerBuilder

    NavigationPaneSettings(FileManagerNavigationPaneSettings)

    Specifies the navigationpane settings of the file manager.

    Declaration
    public FileManagerBuilder NavigationPaneSettings(FileManagerNavigationPaneSettings navigationPaneSettings)
    Parameters
    Type Name Description
    FileManagerNavigationPaneSettings navigationPaneSettings
    Returns
    Type Description
    FileManagerBuilder

    NavigationPaneSettings(Action<FileManagerNavigationPaneSettingsBuilder>)

    Declaration
    public FileManagerBuilder NavigationPaneSettings(Action<FileManagerNavigationPaneSettingsBuilder> navigationPaneSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerNavigationPaneSettingsBuilder> navigationPaneSettings
    Returns
    Type Description
    FileManagerBuilder

    Path(String)

    Specifies the current path of the file manager.

    Declaration
    public FileManagerBuilder Path(string path)
    Parameters
    Type Name Description
    System.String path
    Returns
    Type Description
    FileManagerBuilder

    PopupClose(String)

    Triggers when the dialog is closed.

    Declaration
    public FileManagerBuilder PopupClose(string popupClose)
    Parameters
    Type Name Description
    System.String popupClose
    Returns
    Type Description
    FileManagerBuilder

    PopupOpen(String)

    Triggers when the dialog is opened.

    Declaration
    public FileManagerBuilder PopupOpen(string popupOpen)
    Parameters
    Type Name Description
    System.String popupOpen
    Returns
    Type Description
    FileManagerBuilder

    PopupTarget(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.

    Declaration
    public FileManagerBuilder PopupTarget(string popupTarget)
    Parameters
    Type Name Description
    System.String popupTarget
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    SearchSettings(FileManagerSearchSettings)

    Specifies the search settings of the file manager.

    Declaration
    public FileManagerBuilder SearchSettings(FileManagerSearchSettings searchSettings)
    Parameters
    Type Name Description
    FileManagerSearchSettings searchSettings
    Returns
    Type Description
    FileManagerBuilder

    SearchSettings(Action<FileManagerSearchSettingsBuilder>)

    Declaration
    public FileManagerBuilder SearchSettings(Action<FileManagerSearchSettingsBuilder> searchSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerSearchSettingsBuilder> searchSettings
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    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
    Type Name Description
    SortOrder sortOrder
    Returns
    Type Description
    FileManagerBuilder

    Success(String)

    Triggers when the AJAX request is success.

    Declaration
    public FileManagerBuilder Success(string success)
    Parameters
    Type Name Description
    System.String success
    Returns
    Type Description
    FileManagerBuilder

    ToolbarClick(String)

    Triggers when the toolbar item is clicked.

    Declaration
    public FileManagerBuilder ToolbarClick(string toolbarClick)
    Parameters
    Type Name Description
    System.String toolbarClick
    Returns
    Type Description
    FileManagerBuilder

    ToolbarCreate(String)

    Triggers before creating the toolbar.

    Declaration
    public FileManagerBuilder ToolbarCreate(string toolbarCreate)
    Parameters
    Type Name Description
    System.String toolbarCreate
    Returns
    Type Description
    FileManagerBuilder

    ToolbarSettings(FileManagerToolbarSettings)

    Specifies the group of items aligned horizontally in the toolbar.

    Declaration
    public FileManagerBuilder ToolbarSettings(FileManagerToolbarSettings toolbarSettings)
    Parameters
    Type Name Description
    FileManagerToolbarSettings toolbarSettings
    Returns
    Type Description
    FileManagerBuilder

    ToolbarSettings(Action<FileManagerToolbarSettingsBuilder>)

    Declaration
    public FileManagerBuilder ToolbarSettings(Action<FileManagerToolbarSettingsBuilder> toolbarSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerToolbarSettingsBuilder> toolbarSettings
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Description
    FileManagerBuilder

    UploadSettings(FileManagerUploadSettings)

    Specifies the upload settings for the file manager.

    Declaration
    public FileManagerBuilder UploadSettings(FileManagerUploadSettings uploadSettings)
    Parameters
    Type Name Description
    FileManagerUploadSettings uploadSettings
    Returns
    Type Description
    FileManagerBuilder

    UploadSettings(Action<FileManagerUploadSettingsBuilder>)

    Declaration
    public FileManagerBuilder UploadSettings(Action<FileManagerUploadSettingsBuilder> uploadSettings)
    Parameters
    Type Name Description
    System.Action<FileManagerUploadSettingsBuilder> uploadSettings
    Returns
    Type Description
    FileManagerBuilder

    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
    Type Name Description
    ViewType view
    Returns
    Type Description
    FileManagerBuilder

    Width(Double)

    Specifies the width of the file manager.

    Declaration
    public FileManagerBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    FileManagerBuilder

    Width(String)

    Specifies the width of the file manager.

    Declaration
    public FileManagerBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    FileManagerBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved