En savoir plus sur Xeed Workbooks pour .NET

Bienvenue dans cette nouvelle série ! Cette fois-ci, nous allons passer en revue le dernier ajout à la collection Xceed : Workbooks for .NET

Nous commencerons par les bases de la création d'un document, puis nous aborderons des sujets plus avancés dans les prochains articles.

Qu'est-ce que ce nouveau Workbooks for .NET ?

Xceed Workbooks for .NET est un moyen rapide et léger de créer ou de manipuler des documents Microsoft Excel à partir de vos applications .NET, sans nécessiter l'installation d'Excel ou d'Office.

Grâce à son API facile à utiliser, Xceed Workbooks for .NET permet à votre application de créer ou de modifier des documents Microsoft Excel .xlsx et vous donne un contrôle total sur le contenu de ces documents. Il vous permet de modifier le contenu des cellules, de redimensionner les colonnes et les lignes, de créer des tableaux formatés, etc.

Il peut également constituer un excellent outil de reporting, par exemple en créant des rapports d'entreprise, puis en les utilisant comme modèle que vous personnalisez par programmation avant d'envoyer chaque rapport.

Xceed Workbooks for .NET peut être utilisé pour créer des factures par programmation, ajouter des données à des documents, effectuer des calculs de formule, etc.

Pour commencer

Créons notre premier projet !

Tout d'abord, assurez-vous que vous n'avez pas oublié d'ajouter l'instruction using :

using Xceed.Workbooks.NET;

Si vous utilisez .NET Core, .NET 5 et au-delà, vous devrez activer manuellement le produit, mais ne vous inquiétez pas, il s'agit d'un processus très simple. Vous devrez vous assurer d'avoir votre clé de licence à portée de main pour ce faire.

Si vous utilisez une application console, ajoutez simplement la déclaration suivante dans le module principal :

Xceed.Workbooks.NET.Licenser.LicenseKey = "Your-License-Key";

Dans une application Winforms ou WPF, vous devez le définir avant l'instruction InitializeComponent() ;, de sorte qu'il ressemble à ceci :

Xceed.Workbooks.NET.Licenser.LicenseKey = "Your-License-Key";
InitializeComponent();

Voyons ensuite comment créer simplement un document vierge. Il suffit de spécifier le nom du fichier (ou le chemin d'accès et le nom du fichier), puis d'enregistrer le document.

// Create a new document as a file
using( var document = Workbook.Create( "NewDocument.xlsx" ) )
{
	// Save the workbook to the file.
	document.Save();
}

Une autre option consiste à enregistrer le document dans un flux :

// Create a new document as a stream
var stream = new MemoryStream();
using( var document = Workbook.Create( stream ) )
{
	// Save the workbook in the stream.
	document.Save();
}

Nous pouvons également ouvrir un document existant au lieu d'en créer un nouveau (en utilisant l'option Chargement au lieu de Créer), et nous pouvons choisir d'enregistrer dans un nouveau document au lieu d'écraser le document existant (en utilisant la fonction Sauvegarde au lieu de Économisez). Le document à ouvrir peut provenir d'un fichier ou d'un flux, et la nouvelle copie peut également être enregistrée dans un nouveau fichier ou dans un flux.

// Open an existing document from a file
using( var document = Workbook.Load( "ExistingDocument.xlsx" ) )
{
	// Save this document to disk to a new file.
	document.SaveAs( "NewCopy.docx" );
	// Save this document to a stream instead
	var stream = new MemoryStream();
	document.SaveAs( stream );
}

// Open an existing document from a stream
using( var document = Workbook.Load( existingStream ) )
{
	// Save this document to disk to a new file.
	document.SaveAs( "NewCopy.docx" );
	// Save this document to a stream instead
	var stream = new MemoryStream();
	document.SaveAs( stream );
}

Notes:

• The Create, Load and SaveAs methods all expect either a String or Stream as parameter.

Ajouter et récupérer des feuilles de travail

Un document vierge n'est pas très utile, mais avant d'ajouter du contenu à une feuille de calcul, voyons comment nous pouvons ajouter des feuilles de calcul ou en obtenir une spécifique à partir de notre document.

Note:

• A Workbook will always have a Worksheet by default, whether it is created or loaded.

L'ajout d'une nouvelle feuille de calcul s'effectue en appelant la fonction Ajouter sur la fonction Feuilles de travail du document ; le nom de la feuille de calcul peut également être spécifié à ce moment-là.

// Insert a new worksheet.
document.Worksheets.Add();

// Insert a new worksheet named "Tests"
document.Worksheets.Add("Tests");

Pour rechercher un Feuille de travail dans un document, nous utilisons la méthode Feuilles de travail et spécifier soit l'index basé sur 0, soit le nom de la feuille souhaitée.

// Get the 2nd worksheet
var worksheetA = document.Worksheets[ 1 ];

// Get the worksheet named "Tests"
var worksheetB = document.Worksheets[ "Tests" ];

Nous pouvons également vérifier si une feuille de calcul spécifique existe d'abord en utilisant la fonction Contient sur la fonction Feuilles de travail collection.

// Verify if a worksheet named "Tests" exists in the document
if ( document.Worksheets.Contains( "Tests" ) )
{
	Debug.WriteLine( "Worksheet Found" );
}

Et voilà ! Vos premiers pas dans la création d'un document Workbooks (xlsx) à l'aide de C#. L'étape suivante consistera à ajouter et à modifier son contenu. Nous commencerons à couvrir cela dans notre prochain article. A bientôt !

Pour plus d'informations, veuillez vous référer à la la documentation.