menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class FileManagerEvents<TValue> - API Reference

    Show / Hide Table of Contents

    Class FileManagerEvents<TValue>

    Represents the FileManagerEvents component.

    Inheritance
    System.Object
    FileManagerEvents<TValue>
    Namespace: Syncfusion.Blazor.FileManager
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class FileManagerEvents<TValue> : OwningComponentBase
    Type Parameters
    Name Description
    TValue

    TValue.

    Constructors

    FileManagerEvents()

    Declaration
    public FileManagerEvents()

    Properties

    BeforeDownload

    Gets or sets an event callback that will be invoked before sending the download request to the server.

    Declaration
    public EventCallback<BeforeDownloadEventArgs<TValue>> BeforeDownload { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<BeforeDownloadEventArgs<TValue>>

    An event callback

    Remarks

    This callback can be used to capture the download file details. Additionally, the download operation can be canceled or a custom download can be initiated from this event.

    BeforeImageLoad

    Gets or sets an event callback that will be invoked before sending the image request to the server.

    Declaration
    public EventCallback<BeforeImageLoadEventArgs<TValue>> BeforeImageLoad { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<BeforeImageLoadEventArgs<TValue>>

    An event callback

    Remarks

    This callback can be used to pass additional attributes that are required to load the image through the event.

    BeforePopupClose

    Gets or sets an event callback that will be invoked before the dialog is closed.

    Declaration
    public EventCallback<BeforePopupOpenCloseEventArgs> BeforePopupClose { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<BeforePopupOpenCloseEventArgs>

    An event callback

    Remarks

    This callback can be used to capture the dialog closing action and perform any necessary actions before the dialog is closed.

    BeforePopupOpen

    Gets or sets an event callback that will be invoked before the dialog is opened.

    Declaration
    public EventCallback<BeforePopupOpenCloseEventArgs> BeforePopupOpen { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<BeforePopupOpenCloseEventArgs>

    An event callback

    Remarks

    This callback can be used to perform any necessary actions, such as refreshing the dialog content or making content changes, before the dialog is opened.

    Created

    Gets or sets an event callback that will be invoked when the FileManager component is created.

    Declaration
    public EventCallback<object> Created { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An event callback

    Remarks

    This callback can be used to perform necessary actions once the component will be rendered.

    Destroyed

    Gets or sets an event callback that will be invoked when the FileManager component is destroyed.

    Declaration
    public EventCallback<object> Destroyed { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An event callback

    Remarks

    This callback can be used to perform necessary actions once the component is destroyed.

    FileDropped

    Gets or sets an event callback that will be invoked after a file or folder has been dropped.

    Declaration
    public EventCallback<FileDragEventArgs<TValue>> FileDropped { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileDragEventArgs<TValue>>

    An event callback

    Remarks

    This callback can be used to capture the drop of a file or folder and perform any necessary actions.

    FileSelected

    Gets or sets an event callback that will be invoked when the file or folder is selected or unselected.

    Declaration
    public EventCallback<FileSelectEventArgs<TValue>> FileSelected { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileSelectEventArgs<TValue>>

    An event callback

    Remarks

    This callback allows to capture the selected or unselected file details.

    FileSelection

    Gets or sets an event callback that will be invoked before a file or folder is selected.

    Declaration
    public EventCallback<FileSelectionEventArgs<TValue>> FileSelection { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileSelectionEventArgs<TValue>>

    An event callback.

    Remarks

    This callback is used to prevent the selection of a file or folder in certain cases, or to perform actions before a file or folder is selected.

    MenuOpened

    Gets or sets an event callback that will be invoked before the context menu is opened.

    Declaration
    public EventCallback<MenuOpenEventArgs<TValue>> MenuOpened { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<MenuOpenEventArgs<TValue>>

    An event callback that can be used to modify or customize the context menu items.

    Remarks

    This callback is triggered before the context menu is opened and allows customization of the menu items.

    OnError

    Gets or sets an event callback that will be invoked when the AJAX request fails.

    Declaration
    public EventCallback<FailureEventArgs> OnError { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FailureEventArgs>

    An event callback

    Remarks

    This callback can be used to capture the error details of the file operation failures and take any necessary actions.

    OnFileDragStart

    Gets or sets an event callback that will be invoked when the file or folder dragging is started.

    Declaration
    public EventCallback<FileDragEventArgs<TValue>> OnFileDragStart { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileDragEventArgs<TValue>>

    An event callback

    Remarks

    This callback allows to capture the drag start of the file or folder and can be used to prevent dragging of required folders.

    OnFileDragStop

    Gets or sets an event callback that will be invoked before the file or folder is dropped at the target.

    Declaration
    public EventCallback<FileDragEventArgs<TValue>> OnFileDragStop { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileDragEventArgs<TValue>>

    An event callback

    Remarks

    This callback allows to prevent the drop of file or folder in required cases.

    OnFileLoad

    Gets or sets an event callback that will be invoked before the file or folder is rendered.

    Declaration
    public EventCallback<FileLoadEventArgs<TValue>> OnFileLoad { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileLoadEventArgs<TValue>>

    An event callback

    Remarks

    This callback allows capturing the file load event and performing any necessary actions before the file or folder is rendered.

    OnFileOpen

    Gets or sets an event callback that will be invoked before the file or folder is opened.

    Declaration
    public EventCallback<FileOpenEventArgs<TValue>> OnFileOpen { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<FileOpenEventArgs<TValue>>

    An event callback

    Remarks

    This callback can be used to prevent opening of any particular file or folder in required cases.

    OnMenuClick

    Gets or sets an event callback that will be invoked when the context menu item is clicked.

    Declaration
    public EventCallback<MenuClickEventArgs<TValue>> OnMenuClick { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<MenuClickEventArgs<TValue>>

    An event callback

    Remarks

    This callback allows to perform required actions when the context menu item is clicked.

    OnSend

    Gets or sets an event callback that will be invoked before sending the HttpClient request to the server.

    Declaration
    public EventCallback<BeforeSendEventArgs> OnSend { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<BeforeSendEventArgs>

    An event callback

    Remarks

    This callback can be used to pass any additional data, such as JWT token, along with the HttpClient request.

    OnSuccess

    Gets or sets an event callback that will be invoked when the HttpClient request is successful.

    Declaration
    public EventCallback<SuccessEventArgs<TValue>> OnSuccess { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<SuccessEventArgs<TValue>>

    An event callback.

    Remarks

    This callback allows obtaining the result of a successful request action.

    PopupClosed

    Gets or sets an event callback that will be invoked when the dialog is closed.

    Declaration
    public EventCallback<PopupOpenCloseEventArgs> PopupClosed { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<PopupOpenCloseEventArgs>

    An event callback

    Remarks

    This callback allows to perform required actions after the dialog closes.

    PopupOpened

    Gets or sets an event callback that will be invoked when the dialog is opened.

    Declaration
    public EventCallback<PopupOpenCloseEventArgs> PopupOpened { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<PopupOpenCloseEventArgs>

    An event callback

    Remarks

    This callback allows performing required actions after the dialog opens, such as setting focus to a specific element or loading data dynamically.

    ToolbarCreated

    Gets or sets an event callback that will be invoked before creating the toolbar of the SfFileManager<TValue> component.

    Declaration
    public EventCallback<ToolbarCreateEventArgs> ToolbarCreated { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<ToolbarCreateEventArgs>

    An event callback that customizes the existing toolbar items and includes custom toolbar items.

    Remarks

    Use this callback to customize the toolbar of the FileManager component, including the existing toolbar items and the custom ones that are added.

    ToolbarItemClicked

    Gets or sets an event callback that will be invoked when a toolbar item is clicked.

    Declaration
    public EventCallback<ToolbarClickEventArgs<TValue>> ToolbarItemClicked { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<ToolbarClickEventArgs<TValue>>

    An event callback

    Remarks

    This callback allows obtaining details of the clicked toolbar item and performing required actions.

    UploadListCreated

    Gets or sets an event callback that will be invoked before rendering each file item in the upload dialog box.

    Declaration
    public EventCallback<UploadListCreateArgs> UploadListCreated { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<UploadListCreateArgs>

    An event callback to customize the file item details in the upload dialog.

    Remarks

    Use this callback to modify the appearance or behavior of individual file items in the upload dialog.

    Methods

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    OnInitialized()

    Method invoked when the component is ready to start.

    Declaration
    protected override void OnInitialized()
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved