Class
TelerikFileManager<TItem>

The class for the Telerik FileManager component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

cs-api-definition
public class TelerikFileManager<TItem> : DataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikFileManager<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataBoundComponent<TItem>.SetParametersAsync(ParameterView)DataBoundComponent<TItem>.OnParametersSetAsync()DataBoundComponent<TItem>.Rebind()DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)

Constructors

TelerikFileManager()

Declaration

cs-api-definition
public TelerikFileManager()

Properties

DateCreatedField

Defines the DateCreatedField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string DateCreatedField { get; set; }

Property Value

string

DateCreatedUtcField

Defines the DateCreatedUtcField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string DateCreatedUtcField { get; set; }

Property Value

string

DateModifiedField

Defines the DateModifiedField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string DateModifiedField { get; set; }

Property Value

string

DateModifiedUtcField

Defines the DateModifiedUtcField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string DateModifiedUtcField { get; set; }

Property Value

string

DialogFactory

Declaration

cs-api-definition
[CascadingParameter]
public DialogFactory DialogFactory { get; set; }

Property Value

DialogFactory

DirectoriesField

Defines the DirectoriesField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string DirectoriesField { get; set; }

Property Value

string

EnableLoaderContainer

Defines whether the loading container should be shown when there are long-running operations.

Declaration

cs-api-definition
[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

bool

ExtensionField

Defines the ExtensionField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string ExtensionField { get; set; }

Property Value

string

FileManagerSettings

Defines the settings of the component. Children: FileManagerUploadSettings tag.

Declaration

cs-api-definition
[Parameter]
public RenderFragment FileManagerSettings { get; set; }

Property Value

RenderFragment

FileManagerToolBar

Defines the tools for the toolbar. Children: FileManager toolbar tool components like: FileManagerToolBarNewFolderTool (A button that creates a new folder in the current location. Read how to handle the creation in the FileManager Events article), FileManagerToolBarUploadTool (A button that opens a dialog with integrated Upload component. Read more in the FileManager Upload article), FileManagerToolBarSortDirectionTool (A ButtonGroup with ToggleButtons that selects the sort direction (ascending or descending) to sort the files in the current location), FileManagerToolBarSortTool (A SplitButton that selects the desired sort member to sort by), FileManagerToolBarFileViewTool (A ButtonGroup with ToggleButtons that toggles the file and folder visualization between a ListView and a Grid), FileManagerToolBarViewDetailsTool (A Switch that toggles the visibility of the FileManager Preview Pane. By default, the preview pane is hidden), FileManagerToolBarSearchTool (A TextBox that filters the files by name).

Declaration

cs-api-definition
[Parameter]
public RenderFragment FileManagerToolBar { get; set; }

Property Value

RenderFragment

HasDirectoriesField

Defines the HasDirectoriesField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string HasDirectoriesField { get; set; }

Property Value

string

Height

Defines the height of the component.

Declaration

cs-api-definition
[Parameter]
public string Height { get; set; }

Property Value

string

IdField

Defines the IdField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string IdField { get; set; }

Property Value

string

IsDirectoryField

Defines the IsDirectoryField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string IsDirectoryField { get; set; }

Property Value

string

ItemsField

Defines the ItemsField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string ItemsField { get; set; }

Property Value

string

NameField

Defines the NameField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string NameField { get; set; }

Property Value

string

OnCreate

Fires when an item is created.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerCreateEventArgs> OnCreate { get; set; }

Property Value

EventCallback<FileManagerCreateEventArgs>

OnDelete

Fires when a item is deleted.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerDeleteEventArgs> OnDelete { get; set; }

Property Value

EventCallback<FileManagerDeleteEventArgs>

OnDownload

Fires when an item is downloaded.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerDownloadEventArgs> OnDownload { get; set; }

Property Value

EventCallback<FileManagerDownloadEventArgs>

OnEdit

Fires when an item is about to be edited.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerEditEventArgs> OnEdit { get; set; }

Property Value

EventCallback<FileManagerEditEventArgs>

OnModelInit

Fires when a new instance of the model is about to be created. Useful when no parameterless constructor is implemented. If the delegate is not defined Activator.CreateInstance method is used to create a new model instance.

Declaration

cs-api-definition
[Parameter]
public Func<TItem> OnModelInit { get; set; }

Property Value

Func<TItem>

OnRead

Fires when the data is read.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerReadEventArgs> OnRead { get; set; }

Property Value

EventCallback<FileManagerReadEventArgs>

OnUpdate

Fires when a item is updated.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerUpdateEventArgs> OnUpdate { get; set; }

Property Value

EventCallback<FileManagerUpdateEventArgs>

ParentIdField

Defines the ParentIdField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string ParentIdField { get; set; }

Property Value

string

Path

Defines the current working path.

Declaration

cs-api-definition
[Parameter]
public string Path { get; set; }

Property Value

string

PathChanged

Triggered when the path changes.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> PathChanged { get; set; }

Property Value

EventCallback<string>

PathField

Defines the PathField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string PathField { get; set; }

Property Value

string

SelectedItems

Defines the collection of selected items from the Grid or ListView files view. The parameter supports two-way binding.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }

Property Value

IEnumerable<TItem>

SelectedItemsChanged

The event fires when users select or deselect items.

Declaration

cs-api-definition
[Parameter]
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }

Property Value

EventCallback<IEnumerable<TItem>>

SizeField

Defines the SizeField that is used for obtaining the data from a file.

Declaration

cs-api-definition
[Parameter]
public string SizeField { get; set; }

Property Value

string

View

Defines the initial FileManager view. See FileManagerViewType.

Declaration

cs-api-definition
[Parameter]
public FileManagerViewType View { get; set; }

Property Value

FileManagerViewType

ViewChanged

The event fires when users change the active FileManager View.

Declaration

cs-api-definition
[Parameter]
public EventCallback<FileManagerViewType> ViewChanged { get; set; }

Property Value

EventCallback<FileManagerViewType>

Width

Defines the width of the component.

Declaration

cs-api-definition
[Parameter]
public string Width { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides DataBoundComponent<TItem>.Dispose()

InitJsComponentAsync()

Declaration

cs-api-definition
protected Task InitJsComponentAsync()

Returns

Task

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)