Class FileExplorerProperties
Inheritance
System.Object
FileExplorerProperties
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.EJ.dll
Syntax
public class FileExplorerProperties : EJTagHelper
Constructors
FileExplorerProperties()
Declaration
public FileExplorerProperties()
Properties
AjaxAction
Sets the URL of server side ajax handling method that handles file operation like Read, Remove, Rename, Create, Upload, Download, Copy and Move in File Explorer.
Declaration
[JsonProperty("ajaxAction")]
public string AjaxAction { get; set; }
Property Value
Type |
Description |
System.String |
|
AjaxDataType
Specifies the data type of server side ajax handling method.
Declaration
[JsonProperty("ajaxDataType")]
public string AjaxDataType { get; set; }
Property Value
Type |
Description |
System.String |
|
AjaxSettings
Declaration
[JsonProperty("ajaxSettings")]
public object AjaxSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
AllowDragAndDrop
Specifies the drag and drop behavior in FileExplorer
Declaration
[JsonProperty("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowKeyboardNavigation
Specifies the keyboard Navigation option in FileExplorer
Declaration
[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowMultiSelection
Specifeies the state of Multiselection behaviour in FileExplorer
Declaration
[JsonProperty("allowMultiSelection")]
public bool AllowMultiSelection { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
BeforeAjaxRequest
Fires before the ajax request is performed.
Declaration
[JsonProperty("beforeAjaxRequest")]
public string BeforeAjaxRequest { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeDownload
Fires before downloading the files.
Declaration
[JsonProperty("beforeDownload")]
public string BeforeDownload { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeGetImage
Fires before getting image from server
Declaration
[JsonProperty("beforeGetImage")]
public string BeforeGetImage { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeOpen
Fires before files or folders open.
Declaration
[JsonProperty("beforeOpen")]
public string BeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeUpload
Fires before uploading the files
Declaration
[JsonProperty("beforeUpload")]
public string BeforeUpload { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeUploadDialogOpen
Fires before open the upload box.
Declaration
[JsonProperty("beforeUploadDialogOpen")]
public string BeforeUploadDialogOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeUploadSend
Fires when the file is before send to upload.
Declaration
[JsonProperty("beforeUploadSend")]
public string BeforeUploadSend { get; set; }
Property Value
Type |
Description |
System.String |
|
The contextMenu property is used to configure and group required ContextMenu items in FileExplorer control.
Declaration
[JsonProperty("contextMenuSettings")]
public object ContextMenuSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
Copy
Fires when file or folder is copied successfully.
Declaration
[JsonProperty("copy")]
public string Copy { get; set; }
Property Value
Type |
Description |
System.String |
|
Create
Fires when the file created successfully
Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type |
Description |
System.String |
|
CreateFolder
Fires when new folder is created sucessfully in file system.
Declaration
[JsonProperty("createFolder")]
public string CreateFolder { get; set; }
Property Value
Type |
Description |
System.String |
|
CssClass
Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. By defining the root class by using this API, you have to include this root class in CSS.
Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type |
Description |
System.String |
|
Cut
Fires when file or folder is cut successfully.
Declaration
[JsonProperty("cut")]
public string Cut { get; set; }
Property Value
Type |
Description |
System.String |
|
Destroy
Fires when the destroy the FileExplorer
Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type |
Description |
System.String |
|
Drag
Triggered when file has been dragged over the FileExplorer
Declaration
[JsonProperty("drag")]
public string Drag { get; set; }
Property Value
Type |
Description |
System.String |
|
DragStart
Triggered when file has been started dragging
Declaration
[JsonProperty("dragStart")]
public string DragStart { get; set; }
Property Value
Type |
Description |
System.String |
|
DragStop
Triggered when file has been stopped to drag in FileExplorer
Declaration
[JsonProperty("dragStop")]
public string DragStop { get; set; }
Property Value
Type |
Description |
System.String |
|
Drop
Triggered when file has been dropped to FileExplorer
Declaration
[JsonProperty("drop")]
public string Drop { get; set; }
Property Value
Type |
Description |
System.String |
|
EnablePersistence
Save the current model values in browser cookies.
Declaration
[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableResize
Enables or disables the resize support in FileExplorer control.
Declaration
[JsonProperty("enableResize")]
public bool EnableResize { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableRTL
Enables or disables the Right to Left alignment support in FileExplorer control.
Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableThumbnailCompress
Enables or disables the thumbnail image size reduction
Declaration
[JsonProperty("enableThumbnailCompress")]
public bool EnableThumbnailCompress { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
FileTypes
Allows specified type of files only to display in FileExplorer control.
Declaration
[JsonProperty("fileTypes")]
public string FileTypes { get; set; }
Property Value
Type |
Description |
System.String |
|
FilterSettings
By using filterSettings property, you can customize the search functionality of the searchbar in FileExplorer control.
Declaration
[JsonProperty("filterSettings")]
public object FilterSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
GetImage
Fires after image has been loaded from server
Declaration
[JsonProperty("getImage")]
public string GetImage { get; set; }
Property Value
Type |
Description |
System.String |
|
GridSettings
By using the gridSettings property, you can customize the grid behavior in the FileExplorer control.
Declaration
[JsonProperty("gridSettings")]
public object GridSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
Height
Specifies the height of FileExplorer control.
Declaration
[JsonProperty("height")]
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
HtmlAttributes
Specifies the HTML Attributes of the FileExplorer
Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.IDictionary<System.String, System.Object> |
|
IsResponsive
Enables or disables the responsive support for FileExplorer control during the window resizing time.
Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Keydown
Fires this event when down the key.
Declaration
[JsonProperty("keydown")]
public string Keydown { get; set; }
Property Value
Type |
Description |
System.String |
|
Layout
Sets the file view type. There are two view types available, such as grid, tile.
Declaration
[JsonProperty("layout")]
[JsonConverter(typeof(StringEnumConverter))]
public LayoutType Layout { get; set; }
Property Value
LayoutChange
Fires when the file view type is changed.
Declaration
[JsonProperty("layoutChange")]
public string LayoutChange { get; set; }
Property Value
Type |
Description |
System.String |
|
Locale
Sets the culture in FileExplorer.
Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type |
Description |
System.String |
|
MaxHeight
Sets the maximum height of FileExplorer control
Declaration
[JsonProperty("maxHeight")]
public string MaxHeight { get; set; }
Property Value
Type |
Description |
System.String |
|
MaxWidth
Sets the maximum width of FileExplorer control
Declaration
[JsonProperty("maxWidth")]
public string MaxWidth { get; set; }
Property Value
Type |
Description |
System.String |
|
Fires this event when the before opening the ContextMenu of FileExplorer.
Declaration
[JsonProperty("menuBeforeOpen")]
public string MenuBeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
Fires this event when the ContextMenu of FileExplorer item is clicked.
Declaration
[JsonProperty("menuClick")]
public string MenuClick { get; set; }
Property Value
Type |
Description |
System.String |
|
Fires this event when the after opening the ContextMenu of FileExplorer.
Declaration
[JsonProperty("menuOpen")]
public string MenuOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
MinHeight
Sets the minimum height of FileExplorer control
Declaration
[JsonProperty("minHeight")]
public string MinHeight { get; set; }
Property Value
Type |
Description |
System.String |
|
MinWidth
Sets the minimum width of FileExplorer control
Declaration
[JsonProperty("minWidth")]
public string MinWidth { get; set; }
Property Value
Type |
Description |
System.String |
|
Open
Fires when files are successfully opened.
Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type |
Description |
System.String |
|
Paste
Fires when file or folder is copied successfully.
Declaration
[JsonProperty("paste")]
public string Paste { get; set; }
Property Value
Type |
Description |
System.String |
|
Path
The property path denotes the filesystem path that are to be explored. The path for the filesystem can be physical path or relative path, but it has to be relevant to where the Web API is hosted.
Declaration
[JsonProperty("path")]
public string Path { get; set; }
Property Value
Type |
Description |
System.String |
|
Remove
Fires when file or folder is deleted sucessfully.
Declaration
[JsonProperty("remove")]
public string Remove { get; set; }
Property Value
Type |
Description |
System.String |
|
Resize
Fires when resizing is performed for FileExplorer.
Declaration
[JsonProperty("resize")]
public string Resize { get; set; }
Property Value
Type |
Description |
System.String |
|
ResizeStart
Fires when resizing is started for FileExplorer.
Declaration
[JsonProperty("resizeStart")]
public string ResizeStart { get; set; }
Property Value
Type |
Description |
System.String |
|
ResizeStop
Fires this event when the resizing is stopped for FileExplorer.
Declaration
[JsonProperty("resizeStop")]
public string ResizeStop { get; set; }
Property Value
Type |
Description |
System.String |
|
RootFolderName
Specifies the alias name of root folder for FileExplorer control
Declaration
[JsonProperty("rootFolderName")]
public string RootFolderName { get; set; }
Property Value
Type |
Description |
System.String |
|
Select
Fires when the items from grid view or tile view of FileExplorer control is selected.
Declaration
[JsonProperty("select")]
public string Select { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectedFolder
SelectedFolder is used to select the specified folder of FileExplorer control.
Declaration
[JsonProperty("selectedFolder")]
public string SelectedFolder { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectedItems
SelectedItems is used to select the specified items (file, folder) of FileExplorer control.
Declaration
[JsonProperty("selectedItems")]
public ArrayList SelectedItems { get; set; }
Property Value
Type |
Description |
System.Collections.ArrayList |
|
ShowCheckbox
Shows/ Hide the checkbox in FileExplorer
Declaration
[JsonProperty("showCheckbox")]
public bool ShowCheckbox { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Enables or disables the context menu option in FileExplorer control.
Declaration
[JsonProperty("showContextMenu")]
public bool ShowContextMenu { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Shows / Hide the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. And also the footer having the switcher to change the layout view.
Declaration
[JsonProperty("showFooter")]
public bool ShowFooter { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowNavigationPane
Shows / Hide the NavigationPane in FileExplorer
Declaration
[JsonProperty("showNavigationPane")]
public bool ShowNavigationPane { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowRoundedCorner
Specifies the RoundedCorner behaviour in FileExplorer
Declaration
[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowThumbnail
Specifies the view style in FileExplorer
Declaration
[JsonProperty("showThumbnail")]
public bool ShowThumbnail { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Shows / Hide the toolbar in FileExplorer control.
Declaration
[JsonProperty("showToolbar")]
public bool ShowToolbar { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowTreeview
Shows / Hide the Treeview in FileExplorer
Declaration
[Obsolete("ShowTreeview property has deprecated. Use ShowNavigationPane instead of ShowTreeview")]
[JsonProperty("showTreeview")]
public bool ShowTreeview { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
TemplateRefresh
Triggered when refresh the template column elements in the grid view of FileExplorer control
Declaration
[JsonProperty("templateRefresh")]
public string TemplateRefresh { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
[JsonProperty("tools")]
public object Tools { get; set; }
Property Value
Type |
Description |
System.Object |
|
ToolsList property is used to arrange the toolbar items in the FileExplorer control.
Declaration
[JsonProperty("toolsList")]
public List<string> ToolsList { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<System.String> |
|
Unselect
Fires when the items from grid view or tile view of FileExplorer control is unselected.
Declaration
[JsonProperty("unselect")]
public string Unselect { get; set; }
Property Value
Type |
Description |
System.String |
|
UploadBoxSettings
Gets or sets an object that indicates whether to customize the upload behaviour in the FileExplorer
Declaration
[JsonProperty("uploadBoxSettings")]
[Obsolete("UploadBoxSettings property has deprecated. Use UploadSettings instead of UploadBoxSettings")]
public object UploadBoxSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
UploadComplete
Fires when the file uploading is completed.
Declaration
[JsonProperty("uploadComplete")]
public string UploadComplete { get; set; }
Property Value
Type |
Description |
System.String |
|
UploadError
Fires when the file uploading is failed.
Declaration
[JsonProperty("uploadError")]
public string UploadError { get; set; }
Property Value
Type |
Description |
System.String |
|
UploadSettings
Declaration
[JsonProperty("uploadSettings")]
public object UploadSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
UploadSuccess
Fires when the file is uploaded successfully.
Declaration
[JsonProperty("uploadSuccess")]
public string UploadSuccess { get; set; }
Property Value
Type |
Description |
System.String |
|
VirtualItemCount
Specifies the if this is 0, turn off the virtual scrolling. Else need to virtual the item based on count
Declaration
[JsonProperty("virtualItemCount")]
public int VirtualItemCount { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Width
Specifies the width of FileExplorer control.
Declaration
[JsonProperty("width")]
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|
Methods
GetControlDetails()
Declaration
protected override object GetControlDetails()
Returns
Type |
Description |
System.Object |
|
Overrides
ShouldSerializeAjaxSettings()
ShouldSerialize method for AjaxSettings.
Declaration
public bool ShouldSerializeAjaxSettings()
Returns
Type |
Description |
System.Boolean |
|
ShouldSerializeFilterSettings()
ShouldSerialize method for FilterSettings.
Declaration
public bool ShouldSerializeFilterSettings()
Returns
Type |
Description |
System.Boolean |
|
ShouldSerializeGridSettings()
ShouldSerialize method for GridSettings.
Declaration
public bool ShouldSerializeGridSettings()
Returns
Type |
Description |
System.Boolean |
|
ShouldSerialize method for Tools.
Declaration
public bool ShouldSerializeTools()
Returns
Type |
Description |
System.Boolean |
|
ShouldSerialize method for ToolsList.
Declaration
public bool ShouldSerializeToolsList()
Returns
Type |
Description |
System.Boolean |
|
ShouldSerializeUploadBoxSettings()
ShouldSerialize method for UploadBoxSettings.
Declaration
[Obsolete("UploadBoxSettings property has deprecated.Use UploadSettings instead of UploadBoxSettings")]
public bool ShouldSerializeUploadBoxSettings()
Returns
Type |
Description |
System.Boolean |
|
ShouldSerializeUploadSettings()
ShouldSerialize method for UploadSettings.
Declaration
public bool ShouldSerializeUploadSettings()
Returns
Type |
Description |
System.Boolean |
|