Partager via

ServerDocument.GetCustomizationVersion, méthode

  • Article

Retourne la version de Visual Studio Tools pour Office Runtime utilisé pour créer la personnalisation associée au document spécifié.

Espace de noms :  Microsoft.VisualStudio.Tools.Applications
Assembly :  Microsoft.VisualStudio.Tools.Applications.ServerDocument (dans Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntaxe

'Déclaration
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer

public static int GetCustomizationVersion(
    string documentPath
)

Paramètres

  • documentPath
    Type : System.String
    Chemin d'accès complet du document à vérifier.

Valeur de retour

Type : System.Int32
Nombre qui spécifie la version du Visual Studio Tools pour Office Runtime utilisé pour créer la personnalisation associée.

Exceptions

Exception Condition
ArgumentNullException

Le paramètre documentPath est nullune référence null (Nothing en Visual Basic), est vide ou ne contient que des espaces blancs.
FileNotFoundException

Le fichier spécifié par documentPath n'existe pas.
UnknownCustomizationFileException

Le fichier spécifié par documentPath a une extension de nom de fichier qui n'est pas prise en charge par Visual Studio Tools pour Office Runtime.

Notes

Les solutions Office créées dans différentes versions de Visual Studio utilisent des versions différentes du Visual Studio Tools pour Office Runtime. Chaque version du runtime fournit une version différente de la classe ServerDocument qui est conçue pour fonctionner avec les solutions de cette version du runtime. Cette version de la classe ServerDocument peut être utilisée avec des solutions créées à l'aide de Visual Studio 2010 et avec des solutions Microsoft Office 2007 créées à l'aide de Visual Studio 2008.

Les valeurs de retour de cette méthode sont expliquées dans le tableau ci-dessous.

Valeur de retour

Description

0

Le document n'a pas de personnalisation.

1

Le document a une personnalisation créée en utilisant Visual Studio Tools pour Office, version 2003.

2

Le document a une personnalisation créée à l'aide de Visual Studio 2005 Tools pour Office Second Edition runtime. C'est la version du runtime utilisé par les personnalisations pour Microsoft Office 2003 dans Visual Studio 2005 Tools pour Office et Visual Studio 2008.

3

Le document a une personnalisation créée en utilisant Visual Studio 2010 Tools pour Office Runtime ou Visual Studio Tools pour le système Microsoft Office (version 3.0 Runtime). La version 3.0 de l'exécution est utilisée par des personnalisations pour le système Microsoft Office 2007 dans Visual Studio 2008.

Pour plus d'informations sur les différentes versions de Visual Studio Tools pour Office Runtime, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.

Exemples

L'exemple de code suivant crée un ServerDocument qui charge un document spécifié, puis affiche l'URL du manifeste de déploiement de la personnalisation jointe au document. Avant de créer l'objet, le code utilise la méthode GetCustomizationVersion pour vérifier que la personnalisation a été créée en utilisant Visual Studio 2010 Tools pour Office Runtime.

Cet exemple nécessite les actions ou les éléments suivants :

  • Projet d'application console ou un autre projet non-Office.

  • Références aux assemblys suivants :

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si le projet cible .NET Framework 4).

      ou

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll et Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si le projet cible le .NET Framework 3.5).

  • Instructions Imports (pour Visual Basic) ou using pour C#) pour les espaces de noms Microsoft.VisualStudio.Tools.Applications et Microsoft.VisualStudio.Tools.Applications.Runtime au haut de votre fichier de code.

Private Sub CreateServerDocumentFromPath(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            serverDocument1 = New ServerDocument(documentPath)
            MessageBox.Show("The URL of the deployment manifest is: " & vbLf & _
                serverDocument1.DeploymentManifestUrl.ToString())
        End If

    Catch ex As System.IO.FileNotFoundException
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
    Catch ex As UnknownCustomizationFileException
        System.Windows.Forms.MessageBox.Show("The specified document has a file " & _
            "extension that is not supported by Visual Studio Tools for Office.")
    Finally
        If Not (serverDocument1 Is Nothing) Then
            serverDocument1.Close()
        End If
    End Try
End Sub

private void CreateServerDocumentFromPath(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            serverDocument1 = new ServerDocument(documentPath);
            MessageBox.Show("The URL of the deployment manifest is: \n" +
                serverDocument1.DeploymentManifestUrl.ToString());
        }
    }
    catch (System.IO.FileNotFoundException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
    }
    catch (UnknownCustomizationFileException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document has a file " +
            "extension that is not supported by Visual Studio Tools for Office.");
    }
    finally
    {
        if (serverDocument1 != null)
            serverDocument1.Close();
    }
}

Sécurité .NET Framework

Voir aussi

Référence

ServerDocument Classe

Microsoft.VisualStudio.Tools.Applications, espace de noms

Autres ressources

Gestion de documents sur un serveur à l'aide de la classe ServerDocument