Click or drag to resize

FileManager Class

The component for browsing and managing files with access control.
Inheritance Hierarchy
SystemObject
  Component
    StatefulComponent
      StatefulComponentFileManagerState
        GleamTech.FileUltimate.AspNet.UIFileManager

Namespace:  GleamTech.FileUltimate.AspNet.UI
Assembly:  GleamTech.FileUltimate (in GleamTech.FileUltimate.dll) Version: 6.3.8
Syntax
public sealed class FileManager : StatefulComponent<FileManagerState>

The FileManager type exposes the following members.

Constructors
  NameDescription
Public methodFileManager
Initializes a new instance of the FileManager class.
Public methodFileManager(FileUltimateWebConfiguration)
Initializes a new instance of the FileManager class with custom web configuration.
Top
Properties
  NameDescription
Public propertyArchiveBrowsingEnabled
Gets or sets a value that specifies whether browsing inside archive files (.zip etc.) like regular folders should be enabled. Default is true.
Public propertyCheckboxSelectionEnabled
Gets or sets a value that specifies whether "Item check boxes" mode should be forced regardless of being detected as a touch device. Default is false.
Public propertyChooser
Gets or sets a value that specifies whether the component should be displayed as a file/folder chooser. Default is false. In chooser mode, "Choose" and "Cancel" buttons will be displayed at the bottom of the component and double-clicking on a item of allowed type will choose that item instead of doing the default action (download/explore).
Public propertyChooserMultipleSelection
Gets or sets a value that specifies whether multiple item selection should be allowed in chooser mode. Default is false.
Public propertyChooserType
Gets or sets the item type that should be allowed to be chosen in chooser mode. Default is File. Possible values are File, Folder and FileOrFolder.
Public propertyCode exampleClientChosen
Gets or sets the client-side event raised after user chooses items in chooser mode. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientCompressed
Gets or sets the client-side event raised after user compresses (zips) a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientCompressing
Gets or sets the client-side event raised before user compresses (zips) a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientCopied
Gets or sets the client-side event raised after user copies a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientCopying
Gets or sets the client-side event raised before user copies a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientCreated
Gets or sets the client-side event raised after user creates a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientCreating
Gets or sets the client-side event raised before user creates a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientDeleted
Gets or sets the client-side event raised after user deletes a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientDeleting
Gets or sets the client-side event raised before user deletes a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientDownloading
Gets or sets the client-side event raised before user downloads a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientExtracted
Gets or sets the client-side event raised after user extracts (unzips) a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientExtracting
Gets or sets the client-side event raised before user extracts (unzips) a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientFolderChanged
Gets or sets the client-side event raised after user changes folder (navigates to a different folder). The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientLoaded
Gets or sets the client-side event raised after the file manager has been loaded. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientLoading
Gets or sets the client-side event raised before the file manager starts loading. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientMoved
Gets or sets the client-side event raised after user moves a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientMoving
Gets or sets the client-side event raised before user moves a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientPreviewing
Gets or sets the client-side event raised before user previews a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientRenamed
Gets or sets the client-side event raised after user renames a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientRenaming
Gets or sets the client-side event raised before user renames a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientSelectionChanged
Gets or sets the client-side event raised after user selects or deselects items inside a folder. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientUploaded
Gets or sets the client-side event raised after user uploads a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCode exampleClientUploading
Gets or sets the client-side event raised before user uploads a file or folder in file manager. The value should be a valid JavaScript function name which is accessible on the host page. Function names should be specified without parentheses like "FunctionName" or "Namespace.FunctionName".
Public propertyCollapseRibbon
Gets or sets a value that specifies whether the ribbon (top toolbar pane) is displayed in collapsed mode. Default is false.
Public propertyDisplayLanguage
Gets or sets the display (user interface) language of the file manager. It is usually set as the two-letter language names like en, de, fr etc. as the bundled languages are usually for general language names. However it can be also set to specific cultures like en-US, de-DE, fr-FR etc. For example, if the property is set to a specific culture like de-CH (German in Switzerland), the component will first look for the language file FileUltimate-de-CH.xml and if the file is not found, it will load the general (fallback) language file of that culture which is FileUltimate-de.xml. If not set, the language file which matches the current UICulture of the host application will be loaded. If there is no language file which matches the current UICulture or its fallback, then the default language file FileUltimate.xml is loaded.
Public propertyDisplayMode
Gets or sets a value indicating whether the component is rendered as InPlace (default), Panel, Window or Viewport.
(Inherited from Component.)
Public propertyDocumentViewerEnabled
Gets or sets a value that specifies whether viewer for document files should be enabled. Default is true.
Public propertyDownloadOnDoubleClick
Gets or sets a value that specifies whether "Download" action should be triggered when you double-click on a file. Default is false. When not set, "Preview" action will be triggered and if "Preview" permission is not allowed or the file type is not previewable by any of the built-in viewers, then "Open" (open inline in browser or open locally) action will be triggered.
Public propertyDownloadWithChunkedTransferThreshold
Gets or sets the threshold to start using chunked downloading. This property is only useful if you have problems downloading large files due to your environment limitations (reverse proxy etc.). For example, Microsoft Forefront UAG can not parse http reponses when content-length is larger than 2GB (throws HTTP 500 due to 32-bit integer limit). By setting this property to 2GB, files upto 2GB will be sent with content-length set (default download method) but files larger than 2GB will be sent without content-length and with chunked-transfer encoding so that you can bypass UAG's limitation and successfully download the files. The reason this setting is specified as a threshold is that default download method (content-length set) is always better as it allows the browser to know the whole file size thus show progress information. However with chunked-transfer encoding, the browser will not know the whole file size so it will not be able to show progress information but it will still be able to download the file as long as it receives the stream. So users downloading files smaller than this threshold should not be punished with indeterminate progress but also users downloading files larger than this threshold should still be able to successfully download even there is no progress.
Public propertyExcludedExtensionsForPreview
Gets or sets a comma-separated file extensions to exclude from previewing. "Preview" action for these file extensions will be disabled.
Public propertyFormatLanguage
Gets or sets the format language of the document viewer. Format language is used for the number and date/time formats. It is usually set as the specific cultures like en-US, de-DE, fr-FR etc. If not set, the current Culture of the host application will be used.
Public propertyHeight
Gets or sets the height of the component.
(Inherited from Component.)
Public propertyHidden
Gets or sets a value indicating whether the component is displayed when page is loaded. When set to false, the component can be displayed later on client-side manually. For example, the component can be displayed via a button's click event.
(Inherited from Component.)
Public propertyId
Gets or sets the HTML id of the component. Also a javascript variable with the same name is automatically defined and it can be used to access the client-side implementation of the component. If omitted, Id will be automatically set to the class name of this component (e.g camel-case className) and if there are other instances on the same page, to className2 ... classNameX.
(Inherited from Component.)
Public propertyImageThumbnailsEnabled
Gets or sets a value that specifies whether thumbnails for image files should be displayed. Default is true.
Public propertyImageViewerEnabled
Gets or sets a value that specifies whether viewer for image files should be enabled. Default is true.
Public propertyInitialFolder
Gets or sets the folder that should be selected and displayed initially. The value should the full path of the folder specified in format [RootFolderName]:\Some\Folder. When not set, the first root folder will be selected automatically.
Public propertyMaxSizeToCompress
Gets or sets the maximum allowed size to compress (per action). This property can be used to prevent users creating large zip files (or other compressed archive files in future) which is CPU intensive. It can be set in <Number> B/KB/MB/GB/TB format (eg. 1024 or 1024 B, 200 KB, 30 MB, 5 GB, 1 TB). Note that this value is the uncompressed size for the action because it's not possible to determine the compressed size before actually doing the compression. If not set, there will be no size limit for compression.
Public propertyMediaPlayerEnabled
Gets or sets a value that specifies whether player for video and audio files should be enabled. Default is true.
Public propertyPanelOptions
Gets or sets the panel options used for Panel mode.
(Inherited from Component.)
Public propertyProductInfoRendered
Gets or sets a value indicating whether product info/copyright comment is rendered in html.
(Inherited from Component.)
Public propertyResizable
Gets or sets a value that specifies if the component can be resized when the user drags sides.
(Inherited from Component.)
Public propertyResizeHandles
Gets or sets a value that specifies the handles which can be used for resizing the component. Default is South, East and SouthEast. When using Window mode, set ResizeHandles which overrides this property.
(Inherited from Component.)
Public propertyRootFolders
Gets the collection of the root folders to display in the file manager.
Public propertyShowFileExtensions
Gets or sets a value that specifies whether the extension part of the file names should be be displayed. Default is false. When this set to true, the file extension will be also editable in dialog boxes when user is prompted (eg. on Rename and Add to Zip actions).
Public propertyShowFoldersPane
Gets or sets a value that specifies whether the folders pane (left pane) is displayed. Default is true.
Public propertyShowHiddenFilesAndFolders
Gets or sets a value that specifies whether hidden files and subfolders should be displayed. Default is false.
Public propertyShowRibbon
Gets or sets a value that specifies whether the ribbon (top toolbar pane) is displayed. Default is true.
Public propertyShowSystemFilesAndFolders
Gets or sets a value that specifies whether system files and subfolders should be displayed. Default is false.
Public propertyShowSystemTypeDescriptions
Gets or sets a value that specifies whether file and folder type descriptions from the system's registry (eg. Microsoft Word Document) should be displayed. Default is false. If set to false, then simple but current language dependant type descriptions (eg. DOC File) will be shown. If registry access is not be possible, even if this property is enabled, simple type descriptions will be shown.
Public propertySortRootFolders
Gets or sets a value that specifies whether the root folders should be listed in alphabetically sorted order. Default is false. When not set, the root folders are listed in the original collection order.
Public propertyStateId
Gets or sets the state id of the component. This is determined automatically when state is saved to session.
(Inherited from StatefulComponent.)
Public propertyUploadMethods
Gets or sets a comma separated upload methods in priority order. The default value is "Html5, Silverlight, Flash, Html4". It's not recommended to change this property as the default order offers the best upload experience.
Public propertyVideoThumbnailsEnabled
Gets or sets a value that specifies whether thumbnails for video files should be displayed. Default is true.
Public propertyViewLayout
Gets or sets the initial view layout type for listing files and folders on the right pane. Default is LargeIcons. Possible values are ExtraLargeIcons, LargeIcons, MediumIcons, SmallIcons, Details and Tiles.
Public propertyWidth
Gets or sets the width of the component.
(Inherited from Component.)
Public propertyWindowOptions
Gets or sets the windows options used for Window mode.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventCompressed
Occurs after user compresses (zips) a file or folder in file manager.
Public eventCompressing
Occurs before user compresses (zips) a file or folder in file manager.
Public eventCopied
Occurs after user copies a file or folder in file manager.
Public eventCopying
Occurs before user copies a file or folder in file manager.
Public eventCreated
Occurs after user creates a file or folder in file manager.
Public eventCreating
Occurs before user creates a file or folder in file manager.
Public eventDeleted
Occurs after user deletes a file or folder in file manager.
Public eventDeleting
Occurs before user deletes a file or folder in file manager.
Public eventDownloaded
Occurs after user downloads a file or folder in file manager.
Public eventDownloading
Occurs before user downloads a file or folder in file manager.
Public eventExpanded
Occurs after user expands a folder in file manager.
Public eventExpanding
Occurs before user expands a folder in file manager.
Public eventExtracted
Occurs after user extracts (unzips) a file or folder in file manager.
Public eventExtracting
Occurs before user extracts (unzips) a file or folder in file manager.
Public eventFailed
Occurs when an action in file manager fails.
Public eventListed
Occurs after user lists a folder in file manager.
Public eventListing
Occurs before user lists a folder in file manager.
Public eventMoved
Occurs after user moves a file or folder in file manager.
Public eventMoving
Occurs before user moves a file or folder in file manager.
Public eventPreviewed
Occurs after user previews a file or folder in file manager.
Public eventPreviewing
Occurs before user previews a file or folder in file manager.
Public eventRenamed
Occurs after user renames a file or folder in file manager.
Public eventRenaming
Occurs before user renames a file or folder in file manager.
Public eventUploaded
Occurs after user uploads a file or folder in file manager.
Public eventUploading
Occurs before user uploads a file or folder in file manager.
Top
See Also