How to create Excel programmatically using XlsIO in Flutter?

Syncfusion Flutter XlsIO is a non-UI Excel library written natively in Dart for creating Excel documents from scratch. Using this package, you can create Excel documents on the Flutter Mobile and Web platforms.

Steps to protect an Excel workbook programmatically on the Flutter Web platform.

Step 1: Create a new Flutter application project.

1. Open Visual Studio Code (after installing the Dart and Flutter extensions as stated on the setup editor page).
2. Click View -> Command Palette…

3. Type Flutter and choose Flutter: New Application Project.

4. Enter the project name and press the Enter button.
5. Now choose the location of the project.

Step 2: Add the following code to your pubspec.yaml file to install the Syncfusion Flutter XlsIO package in your application. It will be automatically downloaded from Pub once you trigger the flutter pub get command or Get packages option from Visual Studio Code.

dependencies:
   syncfusion_flutter_xlsio: ^18.4.31-beta

Import the following package in your main.dart file:

import 'package:syncfusion_flutter_xlsio/xlsio.dart';

Step 3: Add the following code in the lib/main.dart file to create a simple button.

@override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            FlatButton(
              child: const Text(
                'Generate Excel',
                style: TextStyle(color: Colors.white),
              ),
              color: Colors.blue,
              onPressed: generateExcel,
            )
          ],
        ),
      ),
    );
  }

Step 4: Add the following code to the generateExcel() function to create a Excel document programmatically.

Future<void> generateExcel() async {
 
     // Create an Excel document.
     // Creating a workbook.
     final Workbook workbook = Workbook();
     // Accessing via index.
     final Worksheet sheet = workbook.worksheets[0];
     // Set the text value.
     sheet.getRangeByName('A1').setText('Hello!!');
     // Save and launch the Excel.
     final List<int> bytes = workbook.saveAsStream();
     // Dispose of the document.
     workbook.dispose();
}

Step 5: Use the following code to save and launch the generated Excel file.

1. Add the following dependencies to your pubspec.yaml file.

   path_provider: ^1.6.7
   open_file: ^3.0.1   # Open source library to launch the Excel file in mobile devices

   
   

2. Import the following packages into your main.dart file.

   import 'dart:io'; 
   import 'package:path_provider/path_provider.dart';
   import 'package:open_file/open_file.dart';
   

3. Include Include the following code snippet in the generateExcel() method to open the Excel document in the mobile’s default application (any Excel application).

   // Get the storage folder location using the path_provider package.
   final Directory directory = await getExternalStorageDirectory();
   // Get directory path
   final String path = directory.path;
   // Create an empty file to write Excel data
   final File file = File('$path/output.xlsx');
   // Write Excel data
   await file.writeAsBytes(bytes, flush: true);
   // Launch the file (used open_file package)
   await OpenFile.open('$path/output.xlsx');

   
   

Step 6: Run the sample using the flutter run command. This creates a simple Excel document.

After the application launches, you will get the Excel document below.

Output Excel document created using XlsIO

You can download the complete work sample from create-excel-in-flutter.zip.

Take a moment to peruse the documentation, where you can find basic worksheet data manipulation options along with features like Conditional Formatting, worksheet calculations through formulas, adding charts in worksheets or workbooks, organizing and analyzing data through tables and pivot tables, appending multiple records to a worksheet using template markers, and most importantly, PDF and image conversions, etc., with code examples.

Refer here to explore the rich set of Syncfusion Essential XlsIO features.

Note:

Starting with v16.2.0.x, if you reference Syncfusion assemblies from the trial setup or from the NuGet feed, include a license key in your projects. Refer to this link to learn about generating and registering a Syncfusion license key in your application to use the components without a trial message.

Conclusion

I hope you enjoyed learning about how to create Excel programmatically using XlsIO in Flutter.

You can refer to our XlsIO’s feature tour page to learn about its other groundbreaking features. Explore our UG documentation and online demos to understand how to manipulate data in Excel documents.

If you are an existing user, you can access our latest components from the License and Downloads page. For new users, you can try our 30-day free trial to check out XlsIO and other Syncfusion components.

If you have any queries or require clarification, please let us know in the comments below or contact us through our support forums or feedback portal. We are always happy to assist you!