FAQ C#Consultez toutes les FAQ

Nombre d'auteurs : 39, nombre de questions : 272, dernière mise à jour : 24 mai 2015  Ajouter une question

 

Cette FAQ a été réalisée pour répondre aux questions les plus fréquemment posées concernant C# sur le forum Développement DotNET

Je tiens à souligner qu'elle ne garantit en aucun cas que les informations qu'elle contient sont correctes ; les auteurs font le maximum, mais l'erreur est humaine. Si vous trouvez une erreur, ou que vous souhaitez devenir rédacteur, lisez ceci .

Sur ce, je vous souhaite une bonne lecture.

Commentez cette FAQ : Commentez


SommaireOfficeAutomation (11)
précédent sommaire suivant
 

Microsoft fournit des interfaces permettant de piloter les applications Office depuis une application .NET. C'est ce qu'on appelle l'automation (cf. Qu'est-ce que l'automation Office ? ) . Ces interfaces sont appelées Primary Interop Assemblies (cf. Que sont les Primary Interop Assemblies ? ).

Cette citation, tirée de l'Aide et Support Microsoft, illustre bien les possibilités offertes par l'automation Office :

« Avec Automation, vous pouvez utiliser la fonctionnalité de publipostage de Microsoft Word pour générer des lettres types à partir de données d'une base de données sans que l'utilisateur se rende compte que Word est impliqué. Vous pouvez même utiliser toutes les fonctionnalités de graphiques et d'analyse de données de Microsoft Excel à l'aide d'Automation. Vous n'avez pas besoin d'écrire votre propre moteur de calcul pour fournir la multitude de fonctions mathématiques, financières et techniques fournies par Excel. Il vous suffit d'automatiser Microsoft Excel pour « emprunter » ces fonctionnalités et les incorporer dans votre propre application. »

Un autre moyen de communiquer avec un document Office, est de le considérer comme une base de données. C'est valable évidemment pour Access, mais aussi, et c'est moins connu, pour Excel (cf. Comment lire dans un fichier Excel ? ).

Une troisième méthode est de manipuler directement le format natif des fichiers Office. C'est le cas du projet SourceForge Koogra qui permet de lire un fichier Excel à partir de son format natif BIFF (Binary Interchange File Format).

Depuis la version 2007 d'Office, un nouveau format a vu le jour, c'est le format OpenXML qui n'est autre qu'un fichier XML et donc aisément lisible et modifiable par programmation. Cependant, ce format n'est compatible que pour Office 2007 et éventuellement Office 2003, après avoir installé un patch permettant de lire ce format.

Enfin, sachez qu'il existe des librairies payantes de pilotage des applications Office. Nul besoin d'en dire plus, vous pourrez trouver toutes les informations nécessaires sur votre moteur de recherche préféré, avec des mots-clés tels que : read, write, excel, word, powerpoint, files, .net...

Il est aussi possible de développer un Add-in pour Office ou de développer une application à partir d'un document Office. C'est ce que permettent les Visual Studio Tools pour Office (cf. Que sont les Visual Studio Tools for Office ? ).

Mis à jour le 8 mars 2010 Skalp

L'automation Office est la technologie automation appliquée au modèle objet Office. Cette définition plus détaillée de l'automation est tirée du Support Microsoft :

« Automation (anciennement OLE Automation) est une technologie qui vous permet de tirer parti d'une fonctionnalité ou du contenu d'un programme existant et de l'incorporer à vos propres applications. Automation est basé sur le composant COM (Component Object Model). COM est une architecture logicielle standard basée sur des interfaces, et conçue pour séparer le code en objets autonomes ou composants. Chaque composant expose un jeu d'interfaces par lesquelles toute la communication avec le composant est gérée. Automation est constitué d'un serveur et d'un client. Le serveur Automation est l'application qui expose ses fonctionnalités au travers d'interfaces COM à d'autres applications, appelées clients Automation. »

Mis à jour le 8 mars 2010 Skalp

Les Primary Interop Assemblies (PIAs) sont des assemblys de code managé capables de communiquer avec les assemblys (de code non managé) du modèle objet Office. Cela est rendu possible parce que les assemblys du modèle objet Office exposent des interfaces COM.

Le mot « Primary » est utilisé lorsque ces assemblys sont fournis par l'éditeur. En l'occurrence, pour les assemblys Office, l'éditeur est Microsoft.

Chaque version d'Office a ses propres versions de PIAs. Mais chaque version de PIAs est compatible avec les versions précédentes.
Il est possible de générer soi-même ces assemblys grâce à l'outil .NET TLBIMP. On les appelle dans ce cas des Interop assemblies (IAs) (cf. Comment piloter une application Office dans mon application .NET par automation ? ).

Il faut savoir que les PIAs sont optimisés par Microsoft. De plus, les types définis dans les IAs ne seront pas les mêmes que ceux définis dans les PIAs. Exemple : le type Document d'un PIA est différent du type Document d'un IA ; qui lui-même est différent du type Document d'un autre IA.

Mis à jour le 8 mars 2010 Skalp

Les PIAs sont disponibles dans les installations des applications Office version 2003 et supérieures. Ces modules sont intitulés « Prise en charge de la programmabilité .NET » (« .NET Programmability support »).

Certains PIAs sont aussi disponibles au téléchargement :



Pour les versions 97 et 2000, ou lorsque les PIAs ne sont pas installés, il est possible de générer les IAs à partir d'une installation Office, grâce à l'outil TLBIMP. Cette génération est automatisée dans Visual Studio lorsque les références sont ajoutées dans un projet (cf. Comment piloter une application Office dans mon application .NET par automation ? ).

Mis à jour le 8 mars 2010 Skalp

Les outils Visual Studio pour Office permettent d'utiliser la technologie .NET à partir d'un document Office. Autrement dit, presque tout ce qu'il est possible de faire en winform ou webform est possible au sein du document Office.

Les outils Visual Studio pour Office ne sont valables qu'avec Office 2003 et 2007.

Les modèles de projet VSTO ne sont pas disponibles dans les versions Express de Visual Studio.

Mis à jour le 8 mars 2010 Skalp

Pour pouvoir développer et exécuter des solutions VSTO, il faut installer le Runtime VSTO (VSTOR), dans sa version 2.0 pour Office 2003 et 3.0 pour Office 2007. Celui-ci est disponible sur le centre de téléchargement Microsoft avec le mot-clé : VSTOR.

Les autres composants indispensables sont

  • Le Framework .NET
  • Office 2003 ou 2007, dont :
    • La programmabilité .NET (PIAs)
    • Visual Basic pour Applications

Mis à jour le 8 mars 2010 Skalp

Mis à jour le 8 mars 2010 Skalp

1. Référencer les assemblys
- Ouvrez un nouveau projet dans Visual Studio.
- Dans le menu Projet, cliquez sur Ajouter une référence. Sous l'onglet .NET, sélectionnez l'assembly PIA souhaité dans la liste. Exemple pour Excel 2007 :


2. Faire appel aux bibliothèques. Exemple pour Excel : inclure l'espace de noms Microsoft.Office.Interop.Excel.

3. Initialiser l'application
- Excel : voir 8.2 Excel .
- Word : voir 8.3 Word .

Remarques :
  • Il est inutile de référencer les PIAs pour un projet VSTO.
  • Si les PIAs ne sont pas installés, il est possible de générer les IAs à partir de l'installation d'Office. Dans ce cas, la référence à ajouter se trouve dans l'onglet COM et le composant s'intitule « Microsoft NomDeLApplication Version Object Library ». Exemple pour Excel :


L'espace de nom à inclure dans ce cas peut varier légèrement (Microsoft.Office.Interop.Core).

Mis à jour le 8 mars 2010 Skalp

Code c# : Sélectionner tout
1
2
3
4
5
6
7
8
application.GetType().InvokeMember 
( 
    "Run", 
    System.Reflection.BindingFlags.Default | System.Reflection.BindingFlags.InvokeMethod, 
    null,  
    application,  
    new Object[]{"NomDeLaMacro"} 
);
Où l'objet application est l'instance de l'application Office.

S'il y a des paramètres à passer à la macro, il faut les ajouter dans le tableau d'objets :

Code c# : Sélectionner tout
new Object[]{"NomDeLaMacro", "parametre1", "parametre2"}

Mis à jour le 8 mars 2010 Skalp

Chaque version d'Office a ses propres assemblys. Mais, de la même façon qu'Office, chaque version des assemblys est compatible avec les versions précédentes.

Ainsi, pour être sûr d'être compatible avec un maximum de versions Office, le mieux est d'utiliser les assemblys les plus anciens. Tout ce qui fonctionne avec une version ancienne, fonctionnera avec une version plus récente d'Office.

D'un autre côté, une version ancienne ne permet pas de bénéficier des fonctions apparues dans les versions récentes d'Office.

En général, les assemblys de la version 9 d'Office (Office 2000) suffisent amplement. Mais si vous souhaitez absolument travailler avec des PIAs, alors les assemblys les plus anciennes sont celles d'Office XP.

Il faut savoir que le format des documents Office a été profondément modifié entre la version 8 (Office 97) et 9 (Office 2000). Par conséquent, l'automation Office avec des PIAs d'Office 97 pour des versions supérieures est déconseillée.

Tableau récapitulatif des versions d'Office et de leur appellation commerciale :

Version Appelation commerciale
8.0 Office 97
9.0 Office 2000
10.0 Office XP ou Office 2002
11.0 Office 2003
12.0 Office 2007

Mis à jour le 8 mars 2010 Skalp

Nombreux sont ceux qui rencontrent ce problème : lorsque vous quittez une automation, vous utilisez (à quelques détails près) cette portion de code :

Code c# : Sélectionner tout
1
2
monAppli.Quit(); 
monAppli = null;
Le plus souvent, ceci ne suffit pas à fermer le processus office : vous pouvez toujours le voir dans le gestionnaire des tâches. Ainsi, lorsque vous ouvrez le document, avec lequel vous avez travaillé par automation, depuis Windows, il refuse de l'ouvrir au titre qu'il est en cours d'utilisation par? vous-même !

Voilà donc quelques astuces pour libérer les ressources automation efficacement :
  1. Déclarer les objets avec des variables indépendantes :
    Par exemple, ne faites pas :

    Code c# : Sélectionner tout
    Workbook monClasseur = monAppli.Workbooks.Add();
    Mais plutôt :

    Code c# : Sélectionner tout
    1
    2
    Workbooks mesClasseurs = monappli.Workbooks; 
    Workbook monClasseur = mesClasseurs.Add();
    Pour une automation simple, cela peut passer ; mais pour une automation complexe, cela peut s'avérer extrêmement fastidieux !
  2. Libérer les références aux objets COM :
    Utilisez la méthode suivante pour libérer les références à vos objets COM :

    Code c# : Sélectionner tout
    System.Runtime.InteropServices.Marshal.ReleaseComObject(monAppli);
  3. Utiliser le Garbage Collector (GC) :

    Code c# : Sélectionner tout
    1
    2
    GC.Collect(); 
    GC.WaitForPendingFinalizers();
    Il peut être utile de doubler cette portion, dans le cas où la référence mémoire du process est conservée après le premier appel.
  4. Récupérer l'identifiant du processus office :
    La méthode la plus définitive est de tuer le processus à la fin de l'automation. Il faut pour cela, dans un premier temps, récupérer l'identifiant du processus, et le stocker pendant tout le temps que doit durer l'automation. Exemple pour une automation Word :

    Code c# : Sélectionner tout
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    int processId = 0; 
    // 1. Additionner les identifiants des processus winword avant l'ouverture de l'automation : 
    foreach (Process item in Process.GetProcessesByName("winword")) 
        processId -= item.Id; 
      
    // 2. Ouvrir l'automation : 
    ApplicationClass monAppli = new ApplicationClass(); 
      
    // 3. Ajouter les identifiants des processus winword après l'ouverture de l'automation, 
    // la différence (après - avant) donnera l'identifiant du processus ouvert : 
    foreach (Process item in Process.GetProcessesByName("winword")) 
        processId += item.Id; 
      
    // Automation... 
      
    // Enfin, lorsque l'automation est terminée, il suffit de tuer le processus à partir de son identifiant : 
    Process.GetProcessById(processId).Kill();

Mis à jour le 8 mars 2010 Skalp Thomas Lebrun

Proposer une nouvelle réponse sur la FAQ

Ce n'est pas l'endroit pour poser des questions, allez plutôt sur le forum de la rubrique pour ça


Réponse à la question

Liens sous la question
précédent sommaire suivant
 

Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright © 2017 Developpez Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

 
Responsable bénévole de la rubrique Microsoft DotNET : Hinault Romaric -