Class FileExplorerPropertiesBuilder

Inheritance

System.Object

FileExplorerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

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()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class FileExplorerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

FileExplorerPropertiesBuilder()

Initializes a new instance of the FileExplorerPropertiesBuilder class.

Declaration

public FileExplorerPropertiesBuilder()

FileExplorerPropertiesBuilder(FileExplorer)

Initializes a new instance of the FileExplorerPropertiesBuilder class by the specified button object.

Declaration

public FileExplorerPropertiesBuilder(FileExplorer fileExplorer)

Parameters

Type	Name	Description
FileExplorer	fileExplorer

Methods

AjaxAction(String)

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

public FileExplorerPropertiesBuilder AjaxAction(string ajaxAxtion)

Parameters

Type	Name	Description
System.String	ajaxAxtion

Returns

Type	Description
FileExplorerPropertiesBuilder

AjaxDataType(String)

Specifies the data type of server side ajax handling method.

Declaration

public FileExplorerPropertiesBuilder AjaxDataType(string ajaxDataType)

Parameters

Type	Name	Description
System.String	ajaxDataType

Returns

Type	Description
FileExplorerPropertiesBuilder

AjaxSettings(Action<AjaxActionsBuilder>)

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. For upload, download and getImage API, you can only customize url.

Declaration

public FileExplorerPropertiesBuilder AjaxSettings(Action<AjaxActionsBuilder> ajaxSettings)

Parameters

Type	Name	Description
System.Action<AjaxActionsBuilder>	ajaxSettings

Returns

Type	Description
FileExplorerPropertiesBuilder

AllowDragAndDrop()

Enables or disables the drag and drop behavior in FileExplorer.

Declaration

public FileExplorerPropertiesBuilder AllowDragAndDrop()

Returns

Type	Description
FileExplorerPropertiesBuilder

AllowDragAndDrop(Boolean)

Enables or disables the drag and drop behavior in FileExplorer. A boolean variable allowDragAndDrop is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder AllowDragAndDrop(bool allowDragAndDrop)

Parameters

Type	Name	Description
System.Boolean	allowDragAndDrop

Returns

Type	Description
FileExplorerPropertiesBuilder

AllowKeyboardNavigation()

specifies the keyboard Navigation option for FileExplorer

Declaration

public FileExplorerPropertiesBuilder AllowKeyboardNavigation()

Returns

Type	Description
FileExplorerPropertiesBuilder

AllowKeyboardNavigation(Boolean)

Declaration

public FileExplorerPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)

Parameters

Type	Name	Description
System.Boolean	allowKeyboardNavigation

Returns

Type	Description
FileExplorerPropertiesBuilder

AllowMultiSelection()

Allows to select the multiple files

Declaration

public FileExplorerPropertiesBuilder AllowMultiSelection()

Returns

Type	Description
FileExplorerPropertiesBuilder

AllowMultiSelection(Boolean)

Declaration

public FileExplorerPropertiesBuilder AllowMultiSelection(bool allowMultiSelection)

Parameters

Type	Name	Description
System.Boolean	allowMultiSelection

Returns

Type	Description
FileExplorerPropertiesBuilder

ClientSideEvents(Action<FileExplorerClientSideEventsBuilder>)

Declaration

public FileExplorerPropertiesBuilder ClientSideEvents(Action<FileExplorerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<FileExplorerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
FileExplorerPropertiesBuilder

ContextMenuSettings(Action<FileExplorerContextMenuSettingsBuilder>)

Gets or sets an object that indicates whether to customize the ContextMenu items in FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder ContextMenuSettings(Action<FileExplorerContextMenuSettingsBuilder> items)

Parameters

Type	Name	Description
System.Action<FileExplorerContextMenuSettingsBuilder>	items

Returns

Type	Description
FileExplorerPropertiesBuilder

CssClass(String)

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

public FileExplorerPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
FileExplorerPropertiesBuilder

EnablePersistence()

Save the current model values in browser cookies.

Declaration

public FileExplorerPropertiesBuilder EnablePersistence()

Returns

Type	Description
FileExplorerPropertiesBuilder

EnablePersistence(Boolean)

Save the current model values in browser cookies.A boolean variable enablePersistence is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
FileExplorerPropertiesBuilder

EnableResize()

Enables or disables the resize support in FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder EnableResize()

Returns

Type	Description
FileExplorerPropertiesBuilder

EnableResize(Boolean)

Enables or disables the resize support in FileExplorer control.A boolean variable enableResize is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder EnableResize(bool enableResize)

Parameters

Type	Name	Description
System.Boolean	enableResize

Returns

Type	Description
FileExplorerPropertiesBuilder

EnableRTL()

Enables or disables the Right to Left alignment support in FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder EnableRTL()

Returns

Type	Description
FileExplorerPropertiesBuilder

EnableRTL(Boolean)

Enables or disables the Right to Left alignment support in FileExplorer control.A boolean variable enableRTL is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL

Returns

Type	Description
FileExplorerPropertiesBuilder

EnableThumbnailCompress()

Compress the thumbnail image size

Declaration

public FileExplorerPropertiesBuilder EnableThumbnailCompress()

Returns

Type	Description
FileExplorerPropertiesBuilder

EnableThumbnailCompress(Boolean)

Declaration

public FileExplorerPropertiesBuilder EnableThumbnailCompress(bool enableThumbnailCompress)

Parameters

Type	Name	Description
System.Boolean	enableThumbnailCompress

Returns

Type	Description
FileExplorerPropertiesBuilder

FileTypes(String)

Allows specified type of files only to display in FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder FileTypes(string fileTypes)

Parameters

Type	Name	Description
System.String	fileTypes

Returns

Type	Description
FileExplorerPropertiesBuilder

FilterSettings(Action<FileExplorerFilterSettingsBuilder>)

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

Declaration

public FileExplorerPropertiesBuilder FilterSettings(Action<FileExplorerFilterSettingsBuilder> filterSettings)

Parameters

Type	Name	Description
System.Action<FileExplorerFilterSettingsBuilder>	filterSettings

Returns

Type	Description
FileExplorerPropertiesBuilder

GridSettings(Action<FileExplorerGridSettingsBuilder>)

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

Declaration

public FileExplorerPropertiesBuilder GridSettings(Action<FileExplorerGridSettingsBuilder> gridSettings)

Parameters

Type	Name	Description
System.Action<FileExplorerGridSettingsBuilder>	gridSettings

Returns

Type	Description
FileExplorerPropertiesBuilder

Height(String)

Specifies the height of FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
FileExplorerPropertiesBuilder

IsResponsive()

Enables or disables the responsive support for FileExplorer control during the window resizing time.

Declaration

public FileExplorerPropertiesBuilder IsResponsive()

Returns

Type	Description
FileExplorerPropertiesBuilder

IsResponsive(Boolean)

Enables or disables the responsive support for FileExplorer control during the window resizing time.A boolean variable isResponsive is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive

Returns

Type	Description
FileExplorerPropertiesBuilder

Layout(LayoutType)

Sets the file view type. There are two view types available, such as grid, tile.

Declaration

public FileExplorerPropertiesBuilder Layout(LayoutType layout)

Parameters

Type	Name	Description
LayoutType	layout

Returns

Type	Description
FileExplorerPropertiesBuilder

Locale(String)

Sets the culture in FileExplorer.

Declaration

public FileExplorerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
FileExplorerPropertiesBuilder

MaxHeight(String)

Specifies the maximum height of the FileExplorer

Declaration

public FileExplorerPropertiesBuilder MaxHeight(string maxHeight)

Parameters

Type	Name	Description
System.String	maxHeight

Returns

Type	Description
FileExplorerPropertiesBuilder

MaxWidth(String)

Specifies the maximum width of the FileExplorer

Declaration

public FileExplorerPropertiesBuilder MaxWidth(string maxWidth)

Parameters

Type	Name	Description
System.String	maxWidth

Returns

Type	Description
FileExplorerPropertiesBuilder

MinHeight(String)

Specifies the minimum height of the FileExplorer

Declaration

public FileExplorerPropertiesBuilder MinHeight(string minHeight)

Parameters

Type	Name	Description
System.String	minHeight

Returns

Type	Description
FileExplorerPropertiesBuilder

MinWidth(String)

Specifies the minimum width of the FileExplorer

Declaration

public FileExplorerPropertiesBuilder MinWidth(string minWidth)

Parameters

Type	Name	Description
System.String	minWidth

Returns

Type	Description
FileExplorerPropertiesBuilder

Path(String)

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

public FileExplorerPropertiesBuilder Path(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
FileExplorerPropertiesBuilder

Render()

Renders the FileExplorer instance.

Declaration

public void Render()

RootFolderName(String)

Specifies the alias name of root folder for FileExplorer control

Declaration

public FileExplorerPropertiesBuilder RootFolderName(string rootFolderName)

Parameters

Type	Name	Description
System.String	rootFolderName

Returns

Type	Description
FileExplorerPropertiesBuilder

SelectedFolder(String)

Specifies the selected folder in FileExplorer

Declaration

public FileExplorerPropertiesBuilder SelectedFolder(string selectedFolder)

Parameters

Type	Name	Description
System.String	selectedFolder

Returns

Type	Description
FileExplorerPropertiesBuilder

SelectedItems(ArrayList)

Specifies the selected items of the FileExplorer

Declaration

public FileExplorerPropertiesBuilder SelectedItems(ArrayList selectedItems)

Parameters

Type	Name	Description
System.Collections.ArrayList	selectedItems

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowCheckbox()

Specifies the state of checkbox

Declaration

public FileExplorerPropertiesBuilder ShowCheckbox()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowCheckbox(Boolean)

Declaration

public FileExplorerPropertiesBuilder ShowCheckbox(bool showCheckbox)

Parameters

Type	Name	Description
System.Boolean	showCheckbox

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowContextMenu()

Enables or disables the context menu option in FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder ShowContextMenu()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowContextMenu(Boolean)

Enables or disables the context menu option in FileExplorer control.A boolean variable showContextMenu is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder ShowContextMenu(bool showContextMenu)

Parameters

Type	Name	Description
System.Boolean	showContextMenu

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowFooter()

Enables or disables 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

public FileExplorerPropertiesBuilder ShowFooter()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowFooter(Boolean)

Enables or disables 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.A boolean variable showFooter is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder ShowFooter(bool showFooter)

Parameters

Type	Name	Description
System.Boolean	showFooter

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowNavigationPane()

Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. This is useful to a quick navigation of any folder in the filesystem.

Declaration

public FileExplorerPropertiesBuilder ShowNavigationPane()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowNavigationPane(Boolean)

Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. This is useful to a quick navigation of any folder in the filesystem.A boolean variable showNavigationPane is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder ShowNavigationPane(bool showNavigationPane)

Parameters

Type	Name	Description
System.Boolean	showNavigationPane

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowRoundedCorner()

specifies the rounded corner for FileExplorer

Declaration

public FileExplorerPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowRoundedCorner(Boolean)

Declaration

public FileExplorerPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowThumbnail()

Shows the thumbnail view of the FileExplorer

Declaration

public FileExplorerPropertiesBuilder ShowThumbnail()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowThumbnail(Boolean)

Declaration

public FileExplorerPropertiesBuilder ShowThumbnail(bool showThumbnail)

Parameters

Type	Name	Description
System.Boolean	showThumbnail

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowToolbar()

Shows or disables the toolbar in FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder ShowToolbar()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowToolbar(Boolean)

Shows or disables the toolbar in FileExplorer control.A boolean variable showToolbar is passed as an argument.

Declaration

public FileExplorerPropertiesBuilder ShowToolbar(bool showToolbar)

Parameters

Type	Name	Description
System.Boolean	showToolbar

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowTreeview()

Shows the treeview in FileExplorer

Declaration

[Obsolete("ShowTreeview property has deprecated. Use ShowNavigationPane instead of ShowTreeview")]
public FileExplorerPropertiesBuilder ShowTreeview()

Returns

Type	Description
FileExplorerPropertiesBuilder

ShowTreeview(Boolean)

Declaration

[Obsolete("ShowTreeview property has deprecated.Use ShowNavigationPane instead of ShowTreeView")]
public FileExplorerPropertiesBuilder ShowTreeview(bool showTreeview)

Parameters

Type	Name	Description
System.Boolean	showTreeview

Returns

Type	Description
FileExplorerPropertiesBuilder

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Tools(Action<FileExplorerToolsBuilder>)

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

Declaration

public FileExplorerPropertiesBuilder Tools(Action<FileExplorerToolsBuilder> tools)

Parameters

Type	Name	Description
System.Action<FileExplorerToolsBuilder>	tools

Returns

Type	Description
FileExplorerPropertiesBuilder

ToolsList(List<String>)

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

Declaration

public FileExplorerPropertiesBuilder ToolsList(List<string> toolsList)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	toolsList

Returns

Type	Description
FileExplorerPropertiesBuilder

UploadBoxSettings(Action<FileExplorerUploadBoxSettingsBuilder>)

Specifies the uploadboxsettings of the FileExplorer

Declaration

[Obsolete("UploadBoxSettings property has been deprecated. Use UploadSettings instead of UploadBoxSettings")]
public FileExplorerPropertiesBuilder UploadBoxSettings(Action<FileExplorerUploadBoxSettingsBuilder> uploadBoxSettings)

Parameters

Type	Name	Description
System.Action<FileExplorerUploadBoxSettingsBuilder>	uploadBoxSettings

Returns

Type	Description
FileExplorerPropertiesBuilder

UploadSettings(Action<FileExplorerUploadBoxSettingsBuilder>)

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

Declaration

public FileExplorerPropertiesBuilder UploadSettings(Action<FileExplorerUploadBoxSettingsBuilder> uploadSettings)

Parameters

Type	Name	Description
System.Action<FileExplorerUploadBoxSettingsBuilder>	uploadSettings

Returns

Type	Description
FileExplorerPropertiesBuilder

VirtualItemCount(Int32)

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

Declaration

public FileExplorerPropertiesBuilder VirtualItemCount(int virtualItemCount)

Parameters

Type	Name	Description
System.Int32	virtualItemCount

Returns

Type	Description
FileExplorerPropertiesBuilder

Width(String)

Specifies the width of FileExplorer control.

Declaration

public FileExplorerPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
FileExplorerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString