Skip to content

Commit da4c8fc

Browse files
Merge pull request #6797 from syncfusion-content/984382-filemanager
Updated the Ug document for File Manager Component
2 parents 8c7e697 + c0a971c commit da4c8fc

26 files changed

+230
-202
lines changed

blazor/file-manager/File-Transfer-Protocol-file-system-provider.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ control: File Manager
77
documentation: ug
88
---
99

10-
# File Transfer Protocol file system provider
10+
# File Transfer Protocol (FTP) file system provider
1111

12-
In ASP.NET Core, File Transfer Protocol file system provider allows the users to access to the hosted file system as collection of objects stored in the file storage using File Transfer Protocol. To get started, clone the [EJ2.ASP.NET Core FTP File Provider](https://github.com/SyncfusionExamples/ej2-ftp-aspcore-file-provider) using the following command
12+
In ASP.NET Core, the File Transfer Protocol (FTP) file system provider allows users to access a hosted file system as a collection of objects stored in the file storage using FTP. To get started, clone the [EJ2.ASP.NET Core FTP File Provider](https://github.com/SyncfusionExamples/ej2-ftp-aspcore-file-provider) repository using the following command:
1313

1414
```
1515
1616
git clone https://github.com/SyncfusionExamples/ej2-ftp-aspcore-file-provider.git ej2-ftp-aspcore-file-provider.git
1717
1818
```
1919

20-
After cloning, open the project in Visual Studio and restore the NuGet packages. Now, register File Transfer Protocol details like *hostName*, *userName* and *password* in **SetFTPConnection** method in the File Manager controller to perform the file operations.
20+
After cloning, open the project in Visual Studio and restore the NuGet packages. Register the FTP details, including *hostName*, *userName* and *password* in **SetFTPConnection** method in the File Manager controller to perform the file operations.
2121

2222
```csharp
2323

@@ -43,7 +43,7 @@ After registering the File Transfer Protocol details, just build and run the pro
4343
4444
```
4545

46-
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the File Transfer Protocol file system provider, you need to initialize the File Transfer Protocol file system provider in the controller.
46+
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the FTP file system provider, initialize the FTP file system provider in the controller.
4747

4848
To initialize a local service with the above-mentioned file operations, create a new folder named `Controllers` inside the server part of the project. Then, create a new file with the extension `.cs` inside the Controllers folder and add the necessary file operations code available in the `FTPProviderController.cs` found at this [link](https://github.com/SyncfusionExamples/ftp-aspcore-file-provider/blob/master/Controllers/FTPProviderController.cs). Additionally, you can check out all the necessary file operation method details for this provider in the same GitHub repository.
4949

blazor/file-manager/Firebase-Real-time-Database-file-system-provider.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ control: File Manager
77
documentation: ug
88
---
99

10-
# Firebase file system provider
10+
# Firebase Realtime Database Provider
1111

12-
The [Firebase Real time Database](https://firebase.google.com/) file system provider in **ASP.NET Core** provides the efficient way to store the File Manager file system in a cloud database as JSON representation.
12+
The [Firebase Real time Database](https://firebase.google.com/) file system provider in **ASP.NET Core** provides an efficient way to store the File Manager file system in a cloud database as JSON representation.
1313

14-
### Generate Secret access key from service account
14+
### Generate a Secret Access Key from a Service Account
1515

16-
Follow the given steps to generate the secret access key:
16+
Follow these steps to generate the secret access key:
1717

1818
* Click this [link](https://console.firebase.google.com/u/0/?pli=1) to Firebase console and navigate to the project settings.
1919

@@ -23,13 +23,13 @@ Follow the given steps to generate the secret access key:
2323

2424
![Blazor File Manager displays File System Authentication](images/blazor-filemanager-file-system.png)
2525

26-
* Now, open the Firebase service project from the Google services console, and generate a Secret key.
26+
* Open the Firebase service project from the Google services console and generate a Secret key.
2727

2828
![Generating Key for Service Project in Blazor FileManager](images/blazor-filemanager-generate-key.png)
2929

3030
* After generating the secret key, replace secret key JSON in the access_key.json file in the Firebase Real time Database provider project to enable authentication for performing read and write operations.
3131

32-
To interpolate with the Firebase Real time Database, create a project under Firebase Real time Database, and then enable the **read** and **write** permissions to access the Firebase Database by specifying the rules within the authentication tab of the Firebase project as demonstrated in the following code snippet.
32+
To interact with the Firebase Realtime Database, create a project and enable **read** and **write** permissions by specifying the rules within the authentication tab of the Firebase project, as shown in the following code snippet.
3333

3434
N> By default, rules of a Firebase project will be **false**. To read and write the data, configure the **Rules** as given in the following code snippet in the *Rules* tab in the Firebase Real time Database project.
3535

@@ -88,7 +88,7 @@ Then, create a root node and add children to the root node. Refer to the followi
8888

8989
```
9090

91-
Here, the `Files` denotes the `rootNode` and the subsequent object refers to the children of the root node. `rootNode` will be taken as the root folder of the file system loaded which will be loaded in File Manager component.
91+
Here, the `Files` denotes the `rootNode` and the subsequent object refers to the children of the root node. `rootNode` will be taken as the root folder of the file system loaded in the File Manager component.
9292

9393
After that, clone the [EJ2.ASP.NET Core Firebase Real Time Database File Provider](https://github.com/SyncfusionExamples/ej2-firebase-realtime-database-aspcore-file-provider) and just open the project in Visual Studio and restore the NuGet package.
9494

@@ -116,7 +116,7 @@ In the above code,
116116

117117
* `{give the service account key path}` denotes service account key path which has authentication key for the Firebase Real time Database data.
118118

119-
After configuring the Firebase Real time Database service link, build and run the project. Now, the project will be hosted in `http://localhost:{port}` and just mapping the **ajaxSettings** property of the File Manager component to the appropriate controller methods allows to manage the files in the Firebase Real time Database.
119+
After configuring the Firebase Realtime Database service link, build and run the project. The application will be hosted at `http://localhost:{port}`. Map the **ajaxSettings** property of the File Manager component to the appropriate controller methods to manage the files in the Firebase Realtime Database.
120120

121121
```cshtml
122122
@@ -135,7 +135,7 @@ After configuring the Firebase Real time Database service link, build and run th
135135
136136
```
137137

138-
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the Firebase file system provider, you need to initialize the Firebase file system provider in the controller.
138+
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the Firebase file system provider, initialize the Firebase file system provider in the controller.
139139

140140
To initialize a local service with the above-mentioned file operations, create a new folder named `Controllers` inside the server part of the project. Then, create a new file with the extension `.cs` inside the Controllers folder and add the necessary file operations code available in the `FirebaseProviderController.cs` found at this [link](https://github.com/SyncfusionExamples/firebase-realtime-database-aspcore-file-provider/blob/master/Controllers/FirebaseProviderController.cs). Additionally, you can check out all the necessary file operation method details for this provider in the same GitHub repository.
141141

blazor/file-manager/Google-Drive-file-system-provider.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: post
3-
title: Google Drive provider in Blazor File Manager Component | Syncfusion
3+
title: Google Drive Provider in Blazor File Manager Component | Syncfusion
44
description: Checkout and learn here all about Google Drive file system provider in Syncfusion Blazor File Manager component and more.
55
platform: Blazor
66
control: File Manager
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Google Drive file system provider
1111

12-
The Google Drive file system provider allows the users to manage the files and folders in a Google Drive account. The Google Drive file system provider works on id basis where each file and folder have a unique ID. To get started, clone the [EJ2.ASP.NET Core Google Drive File Provider](https://github.com/SyncfusionExamples/ej2-google-drive-aspcore-file-provider) using the following command.
12+
The Google Drive file system provider allows users to manage files and folders in a Google Drive account. This provider operates on an ID basis, where each file and folder has a unique ID. To begin, clone the [EJ2.ASP.NET Core Google Drive File Provider](https://github.com/SyncfusionExamples/ej2-google-drive-aspcore-file-provider) using the following command:
1313

1414
```
1515
@@ -19,14 +19,14 @@ cd ej2-google-drive-aspcore-file-provider
1919
2020
```
2121

22-
Google Drive file system provider use the [Google Drive APIs](https://developers.google.com/drive/api/v3/reference/) to read the file in the file system and uses the [OAuth 2.0](https://developers.google.com/identity/protocols/OAuth2) protocol for authentication and authorization. To authenticate from the client end, have to obtain OAuth 2.0 client credentials from the `Google API Console`. To learn more about generating the client credentials from the from Google API Console, refer to this [link](https://developers.google.com/identity/protocols/OAuth2UserAgent).
22+
The Google Drive file system provider utilizes the [Google Drive APIs](https://developers.google.com/drive/api/v3/reference/) to read files and folders and employs the [OAuth 2.0](https://developers.google.com/identity/protocols/OAuth2) protocol for authentication and authorization. To authenticate from the client end, OAuth 2.0 client credentials must be obtained from the `Google API Console`. Refer to this [link](https://developers.google.com/identity/protocols/OAuth2UserAgent) for more information on generating client credentials from the Google API Console.
2323

2424
After generating the client secret data, copy the JSON data to the following specified JSON files in the cloned location.
2525

2626
* EJ2FileManagerService > credentials > client_secret.json
2727
* GoogleOAuth2.0Base > credentials > client_secret.json
2828

29-
After updating the credentials, just build and run the project. Now, the project will be hosted in `http://localhost:{port}`, and it will ask to log on to the Gmail account for which created the client secret credentials. Then, provide permission to access the Google Drive files by clicking the allow access button in the page. Now, just mapping the ajaxSettings property of the File Manager component to the appropriate controller methods will allow to manage the files from the Google Drive.
29+
After updating the credentials, build and run the project. The project will be hosted at `http://localhost:{port}` and will prompt a login to the Gmail account for which the client secret credentials were created. Grant permission to access the Google Drive files by clicking the allow access button on the page. Map the `ajaxSettings` property of the File Manager component to the appropriate controller methods to manage the files from Google Drive.
3030

3131
```cshtml
3232
@@ -44,8 +44,8 @@ After updating the credentials, just build and run the project. Now, the project
4444
4545
```
4646

47-
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the Google Drive file system provider, you need to initialize the Google Drive file system provider in the controller.
47+
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion Blazor File Manager component using the Google Drive file system provider, initialize the Google Drive file system provider in the controller.
4848

49-
To initialize a local service with the above-mentioned file operations, create a new folder named `Controllers` inside the server part of the project. Then, create a new file with the extension `.cs` inside the Controllers folder and add the necessary file operations code available in the `GoogleDriveProviderController.cs` found at this [link](https://github.com/SyncfusionExamples/google-drive-aspcore-file-provider/blob/master/EJ2GoogleDriveFileProvider/Controllers/GoogleDriveProviderController.cs). Additionally, you can check out all the necessary file operation method details for this provider in the same GitHub repository.
49+
To initialize a local service with the above-mentioned file operations, create a new folder named `Controllers` inside the server part of the project. Then, create a new file with the extension `.cs` inside the Controllers folder and add the necessary file operations code available in the `GoogleDriveProviderController.cs` found at this [link](https://github.com/SyncfusionExamples/google-drive-aspcore-file-provider/blob/master/EJ2GoogleDriveFileProvider/Controllers/GoogleDriveProviderController.cs). Additionally, all necessary file operation method details for this provider can be found in the same GitHub repository.
5050

5151
N> To learn more about file actions that can be performed with Google drive file system provider, refer to this [link](https://github.com/SyncfusionExamples/ej2-google-drive-aspcore-file-provider#key-features)

blazor/file-manager/SQL-database-file-system-provider.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: post
3-
title: SQL database provider in Blazor File Manager Component | Syncfusion
3+
title: SQL Database Provider in Blazor File Manager Component | Syncfusion
44
description: Checkout and learn here all about SQL database file system provider in Syncfusion Blazor File Manager component and more.
55
platform: Blazor
66
control: File Manager
@@ -9,23 +9,23 @@ documentation: ug
99

1010
# SQL database file system provider
1111

12-
The SQL database file system provider allows the users to manage the file system being maintained in a SQL database table. Unlike the other file system providers, the SQL database file system provider works on ID basis. Here, each file and folder have a unique ID based on which all the file operations will be performed. To get started, clone the [EJ2.ASP.NET Core SQL Server Database File Provider](https://github.com/SyncfusionExamples/ej2-sql-server-database-aspcore-file-provider) using the following command.
12+
The SQL database file system provider allows users to manage a file system maintained in a SQL database table. Unlike other file system providers, this provider operates on an ID basis, where each file and folder has a unique ID used for all file operations. To begin, clone the [EJ2.ASP.NET Core SQL Server Database File Provider](https://github.com/SyncfusionExamples/ej2-sql-server-database-aspcore-file-provider) using the following command:
1313

1414
```json
1515

1616
<add name="FileExplorerConnection" connectionString="Data Source=(LocalDB)\v11.0;AttachDbFilename=|DataDirectory|\FileManager.mdf;Integrated Security=True;Trusted_Connection=true" />
1717

1818
```
1919

20-
After cloning, just open the project in Visual Studio and restore the NuGet packages. To establish the SQL server connection with the database file (for eg: FileManager.mdf), you need to specify the connection string in the web config file as shown below.
20+
After cloning, open the project in Visual Studio and restore the NuGet packages. To establish the SQL server connection with the database file (e.g., FileManager.mdf), specify the connection string in the `web.config` file as follows:
2121

2222
```json
2323

2424
<add name="FileExplorerConnection" connectionString="Data Source=(LocalDB)\v11.0;AttachDbFilename=|DataDirectory|\FileManager.mdf;Integrated Security=True;Trusted_Connection=true" />
2525

2626
```
2727

28-
Then, make an entry for the connection string in `appsettings.json` file as shown below.
28+
Then, add an entry for the connection string in `appsettings.json` file as shown below.
2929

3030
```json
3131

@@ -35,7 +35,7 @@ Then, make an entry for the connection string in `appsettings.json` file as show
3535

3636
```
3737

38-
Now, to configure the database connection, you need to set the connection name, table name and root folder ID value by passing these values to the SetSQLConnection method.
38+
To configure the database connection, set the connection name, table name, and root folder ID by passing these values to the `SetSQLConnection` method:
3939

4040
```csharp
4141

@@ -63,8 +63,8 @@ After configuring the connection, just build and run the project. Now, the proje
6363
6464
```
6565

66-
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the SQL database file system provider, you need to initialize the SQL database file system provider in the controller.
66+
To perform file operations (Read, Create, Rename, Delete, Get file details, Search, Copy, Move, Upload, Download, GetImage) in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor File Manager component using the SQL database file system provider, initialize the SQL database file system provider in the controller.
6767

68-
To initialize a local service with the above-mentioned file operations, create a new folder named `Controllers` inside the server part of the project. Then, create a new file with the extension `.cs` inside the Controllers folder and add the necessary file operations code available in the `SQLProviderController.cs` found at this [link](https://github.com/SyncfusionExamples/sql-server-database-aspcore-file-provider/blob/master/Controllers/SQLProviderController.cs). Additionally, you can check out all the necessary file operation method details for this provider in the same GitHub repository.
68+
To initialize a local service with the above-mentioned file operations, create a new folder named `Controllers` inside the server part of the project. Then, create a new file with the extension `.cs` inside the Controllers folder and add the necessary file operations code available in the `SQLProviderController.cs` found at this [link](https://github.com/SyncfusionExamples/sql-server-database-aspcore-file-provider/blob/master/Controllers/SQLProviderController.cs). Additionally, all necessary file operation method details for this provider can be found in the same GitHub repository.
6969

7070
N> To learn more about file actions that can be performed with SQL database file system provider, refer to this [link](https://github.com/SyncfusionExamples/ej2-sql-server-database-aspcore-file-provider#key-features)

0 commit comments

Comments
 (0)