ASP.NET MVC

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class FileExplorer - ASP.NETMVC API Reference | Syncfusion

    Show / Hide Table of Contents

    Class FileExplorer

    Represents the FileExplorer UI

    Inheritance
    System.Object
    CommonControl
    FileExplorer
    Implements
    System.Web.UI.INamingContainer
    System.Web.UI.IPostBackEventHandler
    System.Web.UI.IPostBackDataHandler
    System.Web.UI.IUrlResolutionService
    Inherited Members
    CommonControl.RaisePostBackEvent(String)
    CommonControl.OnInit(EventArgs)
    CommonControl.OnLoad(EventArgs)
    Namespace: Syncfusion.JavaScript.Web
    Assembly: Syncfusion.EJ.Web.dll
    Syntax
    public class FileExplorer : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

    Constructors

    FileExplorer()

    Declaration
    public FileExplorer()

    Properties

    AjaxAction

    Specifies the AjaxAction of the FileExplorer

    Declaration
    public string AjaxAction { get; set; }
    Property Value
    Type Description
    System.String

    AjaxDataType

    Specifies the Ajax Type of the control

    Declaration
    public string AjaxDataType { get; set; }
    Property Value
    Type Description
    System.String

    AjaxSettings

    By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and success.

    Declaration
    [JsonProperty("ajaxSettings")]
    public AjaxSettings AjaxSettings { get; set; }
    Property Value
    Type Description
    AjaxSettings

    AllowDragAndDrop

    Allows to drag and drop the file

    Declaration
    public bool AllowDragAndDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowKeyboardNavigation

    Specifies the keyboard Navigation option for the control

    Declaration
    public bool AllowKeyboardNavigation { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowMultiSelection

    Specifies the Multiselection behaviour of the control to slecct the multiple files

    Declaration
    public bool AllowMultiSelection { get; set; }
    Property Value
    Type Description
    System.Boolean

    ClientSideOnBeforeAjaxRequest

    Triggers before the Ajax request sent

    Declaration
    public string ClientSideOnBeforeAjaxRequest { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeDownload

    Triggers before file/folder has been download

    Declaration
    public string ClientSideOnBeforeDownload { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeGetImage

    Triggers before get the image

    Declaration
    public string ClientSideOnBeforeGetImage { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeOpen

    Triggers before the file/folder open

    Declaration
    public string ClientSideOnBeforeOpen { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeUpload

    Triggers before file/folder has been upload

    Declaration
    public string ClientSideOnBeforeUpload { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeUploadDialogOpen

    Triggers before upload box open

    Declaration
    public string ClientSideOnBeforeUploadDialogOpen { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnBeforeUploadSend

    Triggers when the file/folder has been before send to upload

    Declaration
    public string ClientSideOnBeforeUploadSend { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnCopy

    Triggers when the file/folder has been copied

    Declaration
    public string ClientSideOnCopy { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnCreate

    Triggers when the control has been created

    Declaration
    public string ClientSideOnCreate { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnCreateFolder

    Triggers when the folder has been created

    Declaration
    public string ClientSideOnCreateFolder { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnCut

    Triggers when the file/folder has been cut

    Declaration
    public string ClientSideOnCut { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnDestroy

    Declaration
    public string ClientSideOnDestroy { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnDrag

    Triggers file/folder has been dragged

    Declaration
    public string ClientSideOnDrag { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnDragStart

    Triggers when start the dragging.

    Declaration
    public string ClientSideOnDragStart { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnDragStop

    Triggers file/folder has been drag has been stopped

    Declaration
    public string ClientSideOnDragStop { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnDrop

    Triggers file/folder has been dropped

    Declaration
    public string ClientSideOnDrop { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnGetImage

    Triggers when the layout has been changed

    Declaration
    public string ClientSideOnGetImage { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnKeydown

    Declaration
    public string ClientSideOnKeydown { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnLayoutChange

    Declaration
    public string ClientSideOnLayoutChange { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnMenuBeforeOpen

    Declaration
    public string ClientSideOnMenuBeforeOpen { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnMenuClick

    Triggers when destroy the control

    Declaration
    public string ClientSideOnMenuClick { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnMenuOpen

    Declaration
    public string ClientSideOnMenuOpen { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnOpen

    Triggers when the file/folder has been opened

    Declaration
    public string ClientSideOnOpen { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnPaste

    Triggers when the file/folder has been pasted

    Declaration
    public string ClientSideOnPaste { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnRemove

    Triggers file/folder has been removed

    Declaration
    public string ClientSideOnRemove { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnResize

    Triggers when rezsizing the control

    Declaration
    public string ClientSideOnResize { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnResizeStart

    Triggers when resizing the control

    Declaration
    public string ClientSideOnResizeStart { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnResizeStop

    Triggers when stops rezsizing the control

    Declaration
    public string ClientSideOnResizeStop { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnSelect

    Triggers file/folder has been selected

    Declaration
    public string ClientSideOnSelect { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnTemplateRefresh

    Triggers when refresh the template of the control

    Declaration
    public string ClientSideOnTemplateRefresh { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnUnselect

    Triggers when the items from grid view or tile view of FileExplorer control is unselected.

    Declaration
    public string ClientSideOnUnselect { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnUploadComplete

    Triggers when the file/folder upload is completed successfully

    Declaration
    public string ClientSideOnUploadComplete { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnUploadError

    Triggers when the file/folder upload is failed

    Declaration
    public string ClientSideOnUploadError { get; set; }
    Property Value
    Type Description
    System.String

    ClientSideOnUploadSuccess

    Triggers when the file/folder has been uploaded successfully

    Declaration
    public string ClientSideOnUploadSuccess { get; set; }
    Property Value
    Type Description
    System.String

    ContextMenuSettings

    By using the contextMenuSettings property, you can customize the ContextMenu in the FileExplorer control.

    Declaration
    [JsonProperty("ContextMenuSettings")]
    public FileExplorerContextMenuSettings ContextMenuSettings { get; set; }
    Property Value
    Type Description
    FileExplorerContextMenuSettings

    CssClass

    Specifies the CssClass of the control to customise the control UI

    Declaration
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    EnablePersistence

    saves the FileExplorer model values in browser cookies

    Declaration
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableResize

    Allows to resize the control

    Declaration
    public bool EnableResize { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRTL

    Right to left view of the control

    Declaration
    public bool EnableRTL { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableThumbnailCompress

    Compress the image in thumbnail view

    Declaration
    public bool EnableThumbnailCompress { get; set; }
    Property Value
    Type Description
    System.Boolean

    FileTypes

    Specifies the FileTypes to be allowed in folder

    Declaration
    public string FileTypes { get; set; }
    Property Value
    Type Description
    System.String

    FilterSettings

    By using filterSettings property, you can customize the search functionality of the search bar in FileExplorer control.

    Declaration
    [JsonProperty("filterSettings")]
    public FileExplorerFilterSettings FilterSettings { get; set; }
    Property Value
    Type Description
    FileExplorerFilterSettings

    GridSettings

    By using the gridSettings property, you can customize the grid behavior in the FileExplorer control.

    Declaration
    [JsonProperty("gridSettings")]
    public FileExplorerGridSettings GridSettings { get; set; }
    Property Value
    Type Description
    FileExplorerGridSettings

    Height

    Specifies the Height of the control

    Declaration
    public Unit Height { get; set; }
    Property Value
    Type Description
    System.Web.UI.WebControls.Unit

    IsResponsive

    Make the control as responsive with window size

    Declaration
    public bool IsResponsive { get; set; }
    Property Value
    Type Description
    System.Boolean

    Layout

    Specifies the layout of the control.There are three types grid,tile and large icons

    Declaration
    public LayoutType Layout { get; set; }
    Property Value
    Type Description
    LayoutType

    Locale

    Specifies the locale of the control

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    MaxHeight

    Specifies the Maximum Height of the control

    Declaration
    public Unit MaxHeight { get; set; }
    Property Value
    Type Description
    System.Web.UI.WebControls.Unit

    MaxWidth

    Specifies the maximim width of the control

    Declaration
    public Unit MaxWidth { get; set; }
    Property Value
    Type Description
    System.Web.UI.WebControls.Unit

    MinHeight

    Specifies the Minimum Height of the control

    Declaration
    public Unit MinHeight { get; set; }
    Property Value
    Type Description
    System.Web.UI.WebControls.Unit

    MinWidth

    Specifies the minimum width of the control

    Declaration
    public Unit MinWidth { get; set; }
    Property Value
    Type Description
    System.Web.UI.WebControls.Unit

    Model

    Collection of FileExplorer model items

    Declaration
    public FileExplorerProperties Model { get; set; }
    Property Value
    Type Description
    FileExplorerProperties

    Path

    Specifies the path of the file/folder

    Declaration
    public string Path { get; set; }
    Property Value
    Type Description
    System.String

    RootFolderName

    Specifies the alias name of root folder for FileExplorer control

    Declaration
    public string RootFolderName { get; set; }
    Property Value
    Type Description
    System.String

    SelectedFolder

    Specifies the selected folder of the control

    Declaration
    public string SelectedFolder { get; set; }
    Property Value
    Type Description
    System.String

    SelectedItems

    The selectedItems is used to select the specified items (file, folder) of FileExplorer control.

    Declaration
    public ArrayList SelectedItems { get; set; }
    Property Value
    Type Description
    System.Collections.ArrayList

    ShowCheckbox

    Shows/Hides the checkbox

    Declaration
    public bool ShowCheckbox { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowContextMenu

    Shows>hide the context menu

    Declaration
    public bool ShowContextMenu { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowFooter

    Shows/hides thee Footer of the control

    Declaration
    public bool ShowFooter { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowNavigationPane

    Shows/hide the navigation panel in the control

    Declaration
    public bool ShowNavigationPane { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowRoundedCorner

    Rounded corner appearance of the control

    Declaration
    public bool ShowRoundedCorner { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowThumbnail

    Shows the files in Thumbnail view

    Declaration
    public bool ShowThumbnail { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowToolbar

    Shows/hides the toolbar

    Declaration
    public bool ShowToolbar { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowTreeview

    Shows / Hides the Treeview

    Declaration
    [Obsolete("ShowTreeview property has deprecated. Use ShowNavigationPane instead of ShowTreeview")]
    public bool ShowTreeview { get; set; }
    Property Value
    Type Description
    System.Boolean

    Tools

    The tools property is used to configure and group required toolbar items in FileExplorer control.

    Declaration
    [JsonProperty("tools")]
    public FileExplorerTools Tools { get; set; }
    Property Value
    Type Description
    FileExplorerTools

    ToolsList

    The toolsList property is used to arrange the toolbar items in the FileExplorer control.

    Declaration
    public List<string> ToolsList { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.String>

    UploadBoxSettings

    Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer.

    Declaration
    [Obsolete("UploadBoxSettings property has deprecated. Use UploadSettings instead of UploadBoxSettings")]
    [JsonProperty("uploadBoxSettings")]
    public FileExplorerUploadBoxSettings UploadBoxSettings { get; set; }
    Property Value
    Type Description
    FileExplorerUploadBoxSettings

    VirtualItemCount

    Specifies this is 0, turn off the virtual scrolling. Else need to virtual the item based on count

    Declaration
    public int VirtualItemCount { get; set; }
    Property Value
    Type Description
    System.Int32

    Width

    Specifies the width of the control

    Declaration
    public Unit Width { get; set; }
    Property Value
    Type Description
    System.Web.UI.WebControls.Unit

    Methods

    DependentScripts()

    Get the dependent script for FileExplorer control

    Declaration
    public List<string> DependentScripts()
    Returns
    Type Description
    System.Collections.Generic.List<System.String>

    GetDependentFiles()

    Get the dependent files for FileExplorer control

    Declaration
    public override List<string> GetDependentFiles()
    Returns
    Type Description
    System.Collections.Generic.List<System.String>
    Overrides
    CommonControl.GetDependentFiles()

    LoadViewState(Object)

    Restores view-state information from a previous page request.

    Declaration
    protected override void LoadViewState(object state)
    Parameters
    Type Name Description
    System.Object state
    Overrides
    CommonControl.LoadViewState(Object)

    OnPreRender(EventArgs)

    Modifying server controls before sending them to the client.

    Declaration
    protected override void OnPreRender(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    PostBackEventHandler(String, Dictionary<String, Object>)

    Used for handling the date in form post back process

    Declaration
    public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)
    Parameters
    Type Name Description
    System.String EventName
    System.Collections.Generic.Dictionary<System.String, System.Object> args
    Overrides
    CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

    Render()

    Render this instance

    Declaration
    public string Render()
    Returns
    Type Description
    System.String

    Render(HtmlTextWriter)

    Render method for rendering control

    Declaration
    protected override void Render(HtmlTextWriter writer)
    Parameters
    Type Name Description
    System.Web.UI.HtmlTextWriter writer
    Overrides
    CommonControl.Render(HtmlTextWriter)

    UpdateServerModel(Dictionary<String, Object>)

    Maintaining viewstate model values on post back

    Declaration
    [Obsolete("ShowTreeview property has deprecated. Use ShowNavigationPane instead of ShowTreeview")]
    public void UpdateServerModel(Dictionary<string, object> ClientModel)
    Parameters
    Type Name Description
    System.Collections.Generic.Dictionary<System.String, System.Object> ClientModel

    Events

    FileExplorerItemBeforeOpen

    Triggers before the Item has been opened

    Declaration
    public event FileExplorer.FileExplorerEventHandler FileExplorerItemBeforeOpen
    Event Type
    Type Description
    FileExplorer.FileExplorerEventHandler

    FileExplorerItemOpen

    Triggers when the Item has been opened

    Declaration
    public event FileExplorer.FileExplorerEventHandler FileExplorerItemOpen
    Event Type
    Type Description
    FileExplorer.FileExplorerEventHandler

    FileExplorerItemSelected

    Triggers when the Item has been selected

    Declaration
    public event FileExplorer.FileExplorerEventHandler FileExplorerItemSelected
    Event Type
    Type Description
    FileExplorer.FileExplorerEventHandler

    Implements

    System.Web.UI.INamingContainer
    System.Web.UI.IPostBackEventHandler
    System.Web.UI.IPostBackDataHandler
    System.Web.UI.IUrlResolutionService
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved