Class FileManagerSearchSettings

Defines the search settings for the filemanager component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
FileManagerSearchSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.FileManager
Assembly: Syncfusion.Blazor.dll
Syntax
public class FileManagerSearchSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

FileManagerSearchSettings()

Declaration
public FileManagerSearchSettings()

Properties

AllowSearchOnTyping

Gets or sets a value to enable or disable the search functionality on typing.

Declaration
[Parameter]
public bool AllowSearchOnTyping { get; set; }
Property Value
Type Description
bool

The default value is true.

FilterDelay

Gets or sets the delay time (in milliseconds) before starting the search operation based on the filter value in the SfFileManager<TValue> component. A value of 0 indicates no delay.

Declaration
[Parameter]
public int FilterDelay { get; set; }
Property Value
Type Description
int

An integer representing the delay time (in milliseconds) before filtering starts. A value of 0 means no delay.
Remarks

By default, the filter query is sent to the server after 500ms of the last input entered in the search box. Setting a delay value here will introduce a delay before filtering starts.

FilterType

Gets or sets the filter type while searching the content. The available filter types are: Contains StartsWith EndsWith.

Declaration
[Parameter]
public FilterType FilterType { get; set; }
Property Value
Type
FilterType

IgnoreCase

If ignoreCase is set to false, searches files that match exactly, else searches files that are case insensitive(uppercase and lowercase letters treated the same).

Declaration
[Parameter]
public bool IgnoreCase { get; set; }
Property Value
Type
bool

Placeholder

Gets or sets the placeholder value to the search input of the File Manager component.

Declaration
[Parameter]
public string Placeholder { get; set; }
Property Value
Type Description
string

Accepts a string. The default value is Null.
Remarks

The search input displays the default placeholder text value as "Search + current selected folder name".

Examples

In the below code example, the placeholder value sets a "Search More Files.." in the FileManager component.

<SfFileManager TValue="FileManagerDirectoryContent">
<FileManagerSearchSettings Placeholder="Search More Files.."></FileManagerSearchSettings>
</SfFileManager>

Methods

Dispose(bool)

Dispose unmanaged resources in the component.

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

Boolean value to dispose the object.
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

Task.
Overrides

OnParametersSetAsync()

Method invoked when the component parameter changed.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

Task.
Overrides

Implements