Gestion de documents sur un serveur à l'aide de la classe ServerDocument
Vous pouvez utiliser la classe ServerDocument dans Visual Studio Tools pour Office Runtime pour gérer plusieurs aspects des personnalisations au niveau du document, même si Microsoft Office Word et Microsoft Office Excel ne sont pas installés. Vous pouvez effectuer les tâches suivantes :
Accéder aux données situées dans le cache de données d'un document ou d'un classeur et modifier ces données. Pour plus d'informations, consultez Utilisation des données en mémoire cache dans le document.
Gérer l'assembly de personnalisation associé à un document. Pour plus d'informations, consultez Gestion de la personnalisation de document.
S'applique à : Les informations contenues dans cette rubrique s'appliquent aux projets de niveau document pour les applications suivantes : Excel 2007, Excel 2010, Word 2007 et Word 2010. Pour en savoir plus, consultez Fonctionnalités disponibles par type d'application et de projet Office.
Présentation de la classe ServerDocument
La classe ServerDocument est conçue pour être utilisée sur des ordinateurs sur lesquels Office n'est pas installé. Par conséquent, vous devez utiliser cette classe dans les applications qui ne s'intègrent pas à Office, telles que les projets de console ou les projets Windows Forms.
Il existe deux versions de la classe ServerDocument dans Visual Studio 2010 Tools pour Office Runtime. La version que vous devez utiliser dépend de la version de .NET Framework ciblée par l'application dans laquelle vous souhaitez utiliser la classe :
Pour les applications qui ciblent le .NET Framework 4, utilisez la classe Microsoft.VisualStudio.Tools.Applications.ServerDocument dans l'assembly Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll.
Pour les applications qui ciblent le .NET Framework 3.5, utilisez la classe Microsoft.VisualStudio.Tools.Applications.ServerDocument, dans l'assembly Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll.
Les deux versions de la classe ServerDocument peuvent être utilisées pour fonctionner sur des personnalisations au niveau du document créées à l'aide de Visual Studio 2010 ou sur des personnalisations au niveau du document pour Excel 2007 et Word 2007, créées à l'aide de Visual Studio 2008.
Pour plus d'informations sur Visual Studio 2010 Tools pour Office Runtime et les extensions Office pour le .NET Framework, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.
Notes
Si vous possédez une application héritée qui utilise la classe ServerDocument dans Visual Studio Tools pour Office System (version 3.0 Runtime), Visual Studio Tools pour Office System (version 3.0 Runtime) doit être installé sur les ordinateurs qui exécutent l'application. Visual Studio 2010 Tools pour Office Runtime ne peut pas exécuter ces applications.
Utilisation des données en mémoire cache dans le document
La classe ServerDocument fournit des membres que vous pouvez utiliser pour utiliser le cache de données dans des documents personnalisés. Pour plus d'informations sur les données en mémoire cache, consultez Mise en cache des données et Accès aux données des documents sur le serveur.
Le tableau ci-dessous répertorie les membres que vous pouvez utiliser pour manipuler les données en mémoire cache.
Tâche |
Membre à utiliser |
|---|---|
Pour déterminer si un document contient un cache de données. |
Méthode IsCacheEnabled. |
Accéder aux données en mémoire cache dans un document. Pour plus d'informations, consultez Accès aux données des documents sur le serveur. |
Propriété CachedData. |
Gestion de la personnalisation de document
Vous pouvez utiliser des membres de la classe ServerDocument pour gérer l'assembly de personnalisation associé à un document. Par exemple, vous pouvez supprimer par programmation la personnalisation d'un document afin que celui-ci ne fasse plus partie d'une personnalisation.
Le tableau ci-dessous répertorie les membres que vous pouvez utiliser pour gérer l'assembly de personnalisation.
Tâche |
Membre à utiliser |
|---|---|
Pour déterminer si un document fait partie d'une personnalisation au niveau du document. |
Méthode GetCustomizationVersion. |
Attacher par programmation une personnalisation à un document au moment de l'exécution. Pour plus d'informations, consultez Comment : attacher des extensions de code managé à des documents |
L'une des méthodes AddCustomization. |
Supprimer par programmation une personnalisation d'un document au moment de l'exécution. Pour plus d'informations, consultez Comment : supprimer des extensions de code managé de documents. |
Méthode RemoveCustomization. |
Obtenir l'URL du manifeste de déploiement associé au document. |
Propriété DeploymentManifestUrl. |
Voir aussi
Tâches
Comment : attacher des extensions de code managé à des documents
Comment : supprimer des extensions de code managé de documents
Référence
Microsoft.VisualStudio.Tools.Applications.ServerDocument