Création d'un complément à Windows Home Server

Ce didacticiel de programmation montre comment créer un complément à Windows Home Server via Visual Studio 2005. La solution comporte deux projets Visual Studio 2005 :

  • Un projet de bibliothèque de classes Visual Studio 2005 utilisé pour créer des onglets Console et Paramètres Windows Home Server.
  • Un projet fondé sur WiX (intégré à Visual Studio 2005) qui produit un package Windows Installer (MSI) utilisé pour déployer le complément.

Ce chapitre vous guide dans la création de la solution et du projet Visual Studio pour les onglets Console et Paramètres. Les étapes de la création du package MSI sont présentées dans un autre chapitre.

Configuration de votre solution de complément

Lors de la création d'un nouveau projet dans Visual Studio, vous pouvez créer, en même temps, une solution Visual Studio qui le contient. Étant donné que vous créez un complément qui ajoute un onglet à la Console Windows Home Server, vous devez créer un fichier .dll. Les fichiers .dll sont créés dans Visual Studio 2005 à l'aide d'un projet de bibliothèque de classes Windows.

Création du projet de bibliothèque de classes

Dans le processus suivant, nous vous expliquons comment créer un projet de bibliothèque de classes Visual Studio et une solution Visual Studio qui contient le projet.

Pour créer un projet de bibliothèque de classes dans Visual Studio
  1. Ouvrez Visual Studio 2005, cliquez sur Fichier, pointez sur Nouveau, puis cliquez sur Projet.

  2. Dans Nouveau projet, sous Types de projets, développez le nœud correspondant au langage de programmation que vous souhaitez utiliser pour créer votre application, soit ici Visual C#.

  3. Cliquez sur Windows, puis dans Modèles, cliquez sur Bibliothèque de classes.

  4. Pour cette procédure pas à pas, appelez votre projet SDKSample.

  5. Remarquez que le Nom de la solution correspond par défaut au nom du projet. Le nom de la solution peut être différent du nom du projet. Cependant, dans le cadre de ce didacticiel, acceptez le nom proposé par défaut, SDKSample.

  6. Veillez à ce que Créer le répertoire pour la solution soit sélectionné.

  7. Vérifiez les champs Nom, Emplacement et Nom de la solution, puis cliquez sur OK pour fermer Nouveau projet et créer votre nouveau projet de bibliothèque de classes. Une nouvelle solution Visual Studio est créée au même moment pour contenir le projet en question.

Définition des propriétés pour le projet de bibliothèque de classes

L'API Windows Home Server exige que votre .dll suive une convention d'affectation de noms spécifique. Si vous ne nommez pas votre .dll en respectant les indications ci-dessous, votre onglet ne sera pas chargé par la Console Windows Home Server.

Voici les conventions d'affectation de noms Windows Home Server pour un fichier .dll qui étend la Console Windows Home Server

Afin de garantir que la Console Windows Home Server reconnaît et charge votre onglet, nommez votre fichier .dll HomeServerConsoleTab.VotreNomOnglet.dll. Vous ne pouvez pas modifier la première partie du nom de fichier, HomeServerConsoleTab. Vous êtes libre d'en choisir la seconde partie, VotreNomOnglet. Cependant, le nom choisi ne doit être utilisé par aucun autre onglet. Cela vous permet de distinguer votre onglet des autres. Par exemple, l'onglet Dossiers partagés dans la Console Windows Home Server est implémenté dans le fichier .dll HomeServerConsoleTab.Sharing.dll.

Pour définir le nom du fichier .dll du projet de bibliothèque de classes
  1. Dans Visual Studio, cliquez avec le bouton droit sur SDKSample sous Explorateur de solutions, puis cliquez sur Propriétés.

  2. Dans l'onglet correspondant aux propriétés SDKSample, cliquez sur Application.

  3. Dans le champ Nom de l'assembly, entrez HomeServerConsoleTab.SDKSample. Plus tard, lors de la création de votre fichier .dll, il comportera la convention d'affectation de noms correcte HomeServerConsoleTab.VotreNomOnglet.dll. Dans le cadre de ce didacticiel, Visual Studio 2005 produira un fichier .dll nommé HomeServerConsoleTab.SDKSample.dll.

  4. Gardez ouvert l'onglet des propriétés pour l'étape suivante.

Par ailleurs, tous les fichiers de code de votre projet doivent déclarer l'espace de noms adéquat. Paramétrez l'espace de noms par défaut pour les fichiers de votre projet dans Espace de noms par défaut sur la page de propriétés du projet. Ainsi, tous les fichiers de classe que vous créez automatiquement disposent de l'espace de noms adéquat.

Important
Vous devez utilisez l'espace de nom Microsoft.HomeServer.HomeServerConsoleTab.VotreNomOnglet (où VotreNomOnglet est le nom de votre onglet Console). Si vous ne le faites pas, la Console Windows Home Server ne reconnaît pas votre onglet Console.

Pour définir l'espace de noms par défaut du projet de bibliothèque de classes
  1. Dans l'onglet de propriétés du projet SDKSample, cliquez surApplication.

  2. Dans le champ Espace de noms par défaut, entrez Microsoft.HomeServer.HomeServerConsoleTab.SDKSample.

  3. Dans le menu principal, cliquez sur Fichier, puis sur Enregistrer tout.

  4. Fermez l'onglet de propriétés SDKSample.

Ajout de ressources de projet

La seule ressource de projet nécessaire à votre projet de bibliothèque de classes est une image bitmap. Elle apparaît sur votre onglet Console et votre onglet Paramètres.

Important
La résolution de l'image bitmap doit être de 32 x 32 pixels. Toute image d'une autre taille ne s'affiche pas correctement.

Dans le cadre de ce didacticiel, nous utilisons un fichier d'image, SDKSample.png, mais vous pouvez utiliser l'image bitmap de votre choix. Suivez les indications ci-dessous pour ajouter l'image.

Pour ajouter l'image bitmap aux ressources du projet de bibliothèque de classes
  1. Dans Visual Studio, cliquez avec le bouton droit de la souris sur SDKSample dans Explorateur de solutions, puis cliquez sur Propriétés.

  2. Dans l'onglet des propriétés SDKSample, cliquez sur Ressources.

  3. S'il s'affiche, cliquez sur le message Ce projet ne contient pas de fichier de ressources par défaut. Cliquez ici pour en créer un.

  4. Cliquez sur la flèche vers le bas à côté de Ajouter une ressource, et cliquez sur Ajouter un fichier existant.

  5. Naviguez jusqu'à l'emplacement de votre image bitmap. Cliquez sur le fichier correspondant puis sur Ouvrir. Une miniature de votre image est ajoutée à la liste des ressources d'images de votre projet, avec le nom du fichier (sans son extension).

    Remarque
    Vous pouvez modifier le nom de fichier de l'image dans le panneau d'affichage Ressources. Par exemple, remplacez SDKSample par SDKSampleImg pour vous rappeler plus facilement à quoi correspond cette ressource lorsqu'elle est référencée dans le code.

  6. Dans le menu principal, cliquez sur Fichier, puis sur Enregistrer tout.

  7. Fermez l'onglet de propriétés SDKSample.

Ajout de références à votre projet de bibliothèque de classes

Afin de créer correctement votre projet, veillez à ajouter les références adéquates. Lorsque vous étendez la Console Windows Home Server, vous devez référencer l'espace de noms Microsoft.HomeServer.Extensibility. L'espace de noms Microsoft.HomeServer.Extensibility comporte le code de l'API que vous utilisez pour créer un nouvel onglet Console ou Paramètres. L'espace de noms Microsoft.HomeServer.Extensibility est contenu dans HomeServerExt.dll.

Ce didacticiel illustre comment utiliser les objets Windows Home Server en plus des onglets Console et Paramètres. Ainsi, vous devez également référencer l'espace de noms Microsoft.HomeServer.SDK.Interop.v1, où tous les autres objets Windows Home Server sont définis. L'espace de noms Microsoft.HomeServer.SDK.Interop.v1 est contenu dans Microsoft.HomeServer.SDK.Interop.v1.dll.

Pour ajouter les références adéquates du projet, copiez HomeServerExt.dll et Microsoft.HomeServer.SDK.Interop.v1.dll vers votre ordinateur de développement, puis ajoutez-leur une référence dans les références de votre projet.

Pour ajouter des références à HomeServerExt.dll et Microsoft.HomeServer.SDK.Interop.v1.dll
  1. Copiez HomeServerExt.dll et Microsoft.HomeServer.SDK.Interop.v1.dll à partir du répertoire %ProgramFiles%\Windows Home Server\ du serveur domestique vers un dossier de votre ordinateur de développement, par exemple, " C:\HomeServerSDK ".

  2. Dans l'affichage de l'Explorateur de solutions de Visual Studio, développez le projet SDKSample.

  3. Cliquez avec le bouton droit sur Références, puis cliquez sur Ajouter une référence.

  4. Dans la boîte de dialogue Ajouter une référence, cliquez sur l'onglet Parcourir, et naviguez jusqu'à l'emplacement sur lequel vous avez copié HomeServerExt.dll et Microsoft.HomeServer.SDK.Interop.v1.dll.

  5. Sélectionnez les deux fichiers en maintenant enfoncée la touche CTRL et en cliquant sur chacun d'entre eux. Cliquez sur OK pour fermer la boîte de dialogue Ajouter une référence.

  6. Répétez les étapes 1 à 5 pour les espaces de noms System.Drawing et System.Windows.Forms, à l'exception du fait que ces références sont sur l'onglet .NET.

  7. HomeServerExt, Microsoft.HomeServer.SDK.Interop.v1, System.Drawing et System.Windows.Forms s'affichent dans le champ Références de l'Explorateur de solutions. Par ailleurs, les nœuds HomeServerExt et Microsoft.HomeServer.SDK.Interop.v1 s'affichent dans la fenêtre Explorateur d'objets de Visual Studio.

  8. Pour cette procédure, renommez le fichier de code pour votre classe HomeServerTabExtender.cs. Pour ce faire, cliquez avec le bouton droit de la souris sur Class1.cs dans l'Explorateur de solutions. Cliquez sur Renommer dans le menu contextuel. Renommez le fichier en HomeServerTabExtender.cs.

  9. Si un message s'affiche vous demandant si vous souhaitez renommer toutes les références à cette classe dans votre projet, cliquez sur Oui.

  10. Dans le menu principal, cliquez sur Fichier, puis sur Enregistrer tout.

Vous avez mis en place votre solution Visual Studio 2005 et les propriétés de votre projet de bibliothèque de classes ont été configurées. Vous pouvez à présent commencer à écrire le code pour votre complément.

Voir aussi

Page view tracker