Gestion de documents sur un serveur à l'aide de la classe ServerDocument
Mise à jour : novembre 2007
S'applique à |
|---|
Les informations de cette rubrique s'appliquent uniquement aux projets Visual Studio Tools pour Office et versions de Microsoft Office spécifiés. Type de projet
Version de Microsoft Office
Pour plus d'informations, consultez Fonctionnalités disponibles par type d'application et de projet. |
Vous pouvez utiliser la classe ServerDocument 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 la personnalisation Visual Studio Tools pour Office pour un document. Pour plus d'informations, consultez Gestion de la personnalisation de document.
Présentation de la classe ServerDocument
Il existe deux versions différentes de la classe ServerDocument, une pour chaque version du runtime de Visual Studio Tools pour Office. Utilisez celle qui correspond à la version de Microsoft Office de la solution :
Utilisez la classe Microsoft.VisualStudio.Tools.Applications.ServerDocument avec les personnalisations destinées à Excel 2007 et Word 2007. Cette classe est fournie par Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime).
Utilisez la classe Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument avec les personnalisations destinées à Excel 2003 et Word 2003. Cette classe est fournie par Visual Studio 2005 Tools pour Office Second Edition Runtime.
La plupart des fonctionnalités sont identiques pour les deux versions de la classe ServerDocument. Il existe toutefois des différences au niveau des espaces de noms, des assemblys et des membres. Pour plus d'informations, consultez Présentation des différences pour ServerDocument.
La classe ServerDocument est conçue pour être utilisée sur les ordinateurs sur lesquels Microsoft Office n'est pas installé. Par conséquent, vous l'utilisez en général dans des projets qui ne s'intègrent pas avec Microsoft Office, comme des projets console ou des projets Windows Forms, plutôt que des projets Visual Studio Tools pour Office.
Pour plus d'informations sur les différentes versions du runtime de Visual Studio Tools pour Office, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.
Utilisation des données en mémoire cache dans le document
Les deux versions de la classe ServerDocument fournissent des membres permettant d'utiliser le cache de données dans les 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 |
Projets Excel 2007 et Word 2007 |
Projets Excel 2003 et Word 2003 |
|---|---|---|
Déterminer si un document contient un cache de données Visual Studio Tools pour Office. |
Méthode IsCacheEnabled dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime). |
Méthode IsCacheEnabled dans Visual Studio 2005 Tools pour Office Second Edition Runtime. |
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 dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime). |
Propriété CachedData dans Visual Studio 2005 Tools pour Office Second Edition Runtime. |
Gestion de la personnalisation de document
Vous pouvez utiliser les membres de la classe ServerDocument pour gérer la personnalisation Visual Studio Tools pour Office d'un document. Par exemple, vous pouvez supprimer par programme la personnalisation d'un document afin que celui-ci ne fasse plus partie d'une personnalisation Visual Studio Tools pour Office.
Le tableau ci-dessous répertorie les membres que vous pouvez utiliser pour gérer l'assembly de personnalisation.
Tâche |
Projets Excel 2007 et Word 2007 |
Projets Excel 2003 et Word 2003 |
|---|---|---|
Déterminer si un document contient une personnalisation Visual Studio Tools pour Office. |
Méthode GetCustomizationVersion dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime). |
Méthode IsCustomized dans Visual Studio 2005 Tools pour Office Second Edition Runtime. |
Attacher par programme une personnalisation à un document au moment de l'exécution. Pour plus d'informations, consultez : |
Une des méthodes AddCustomization dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime). |
Une des méthodes AddCustomization dans Visual Studio 2005 Tools pour Office Second Edition Runtime. |
Supprimer par programme une personnalisation d'un document au moment de l'exécution. Pour plus d'informations, consultez : |
Méthode RemoveCustomization dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime). |
Méthode RemoveCustomization dans Visual Studio 2005 Tools pour Office Second Edition Runtime. |
Obtenir l'URL du manifeste de déploiement associé au document. |
Propriété DeploymentManifestUrl dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime). |
Visual Studio 2005 Tools pour Office Second Edition Runtime n'inclut pas cette propriété, car le manifeste de déploiement est facultatif pour les solutions au niveau du document pour Excel 2003 et Word 2003. En lieu et place, ces solutions comportent toujours un manifeste d'application incorporé. |
Accéder au manifeste d'application incorporé dans le document. |
Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime) n'inclut pas cette propriété, car les solutions au niveau du document pour Excel 2007 et Word 2007 ne comportent pas de manifeste d'application incorporé. |
Propriété AppManifest dans Visual Studio 2005 Tools pour Office Second Edition Runtime. |
Présentation des différences pour ServerDocument
Les deux versions de la classe ServerDocument et les classes connexes qui fournissent le modèle objet pour les données en mémoire cache (CachedDataHostItem et CachedDataItem, par exemple) sont définies dans des assemblys et des espaces de noms différents. En outre, certains membres et surcharges de méthode ne sont fournis que dans une seule version de la classe. Vous devez tenir compte de ces différences dans les scénarios suivants :
Vous souhaitez migrer du code qui utilise la classe ServerDocument dans Visual Studio 2005 Tools pour Office Second Edition Runtime afin qu'il soit compatible avec les solutions Excel 2007 et Word 2007.
Vous souhaitez utiliser la classe ServerDocument dans du code compatible avec les personnalisations au niveau du document pour Microsoft Office 2003 et la version 2007 de Microsoft Office System.
Pour un exemple qui montre comment utiliser les deux versions de la classe ServerDocument dans un même code, consultez Comment : pour écrire du code qui utilise les deux versions de la classe ServerDocument.
Différences au niveau des espaces de noms et des assemblys
Le tableau ci-dessous répertorie les différences au niveau des espaces de noms et des assemblys pour les deux versions de la classe ServerDocument et les classes qui fournissent le modèle objet pour les données en mémoire cache.
Version du runtime |
Espace de noms |
Assembly |
|---|---|---|
Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime) |
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll |
|
Visual Studio 2005 Tools pour Office Second Edition Runtime |
Microsoft.VisualStudio.Tools.Applications.Runtime.dll |
Différences au niveau des membres
Les membres suivants sont fournis uniquement dans la classe ServerDocument dans Microsoft Visual Studio Tools pour Microsoft Office System (version 3.0 Runtime) :
Les membres suivants sont fournis uniquement dans la classe ServerDocument dans Visual Studio 2005 Tools pour Office Second Edition Runtime :
Voir aussi
Tâches
Comment : pour écrire du code qui utilise les deux versions de la classe ServerDocument
Comment : joindre des extensions de code managé à des documents (Office System 2007)
Comment : joindre des extensions de code managé à des documents (Office System 2003)
Comment : supprimer des extensions de code managé de documents (Office System 2007)
Comment : supprimer des extensions de code managé de documents (Office System 2003)
Concepts
Vue d'ensemble de Visual Studio Tools pour Office Runtime
Référence
Microsoft.VisualStudio.Tools.Applications.ServerDocument
Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument