ServerDocument.GetCustomizationVersion(String) Methode

Definition

Gibt die Version von Visual Studio-Tools für Office-Laufzeit zurück, die zum Erstellen der Anpassung verwendet wurde, die dem angegebenen Dokument zugeordnet ist.

public static int GetCustomizationVersion (string documentPath);

Parameter

documentPath
String

Der vollständige Pfad zu dem Dokument, das Sie überprüfen möchten.

Gibt zurück

Int32

Eine Zahl, die die Version von Visual Studio-Tools für Office-Laufzeit angibt, die zum Erstellen der zugeordneten Anpassung verwendet wurde.

Ausnahmen

Der documentPath-Parameter ist entweder null oder leer, oder er besteht nur aus Leerzeichen.

Die Datei, die unter documentPath angegeben ist, ist nicht vorhanden.

Die in documentPath angegebene Datei hat eine Dateinamenerweiterung, die nicht von Visual Studio-Tools für Office-Laufzeit unterstützt wird.

Beispiele

Im folgenden Codebeispiel wird ein neues erstellt ServerDocument , das ein angegebenes Dokument lädt und dann die URL des Bereitstellungs Manifests für die Anpassung anzeigt, die an das Dokument angefügt wird. Vor dem Erstellen des Objekts verwendet der Code die- GetCustomizationVersion Methode, um zu überprüfen, ob die Anpassung mithilfe der Visual Studio 2010-Tools für Office-Laufzeit erstellt wurde.

Für dieses Beispiel benötigen Sie Folgendes:

  • Ein Konsolen Anwendungsprojekt oder ein anderes nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt .NET Framework 4 oder .NET Framework 4.5 als Ziel hat).

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf die .NET Framework 3,5) abzielt.

  • Imports(für Visual Basic) oder using (für c#)-Anweisungen für Microsoft.VisualStudio.Tools.Applications -und- Microsoft.VisualStudio.Tools.Applications.Runtime Namespaces am Anfang der Codedatei.

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();
    }
}
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

Hinweise

Office-Projektmappen, die in verschiedenen Versionen von Visual Studio erstellt wurden, verwenden unterschiedliche Versionen von Visual Studio-Tools für Office-Laufzeit . Jede Version der Laufzeit stellt eine andere Version der-Klasse bereit, die für die Arbeit mit Projektmappen ServerDocument für diese Version der Laufzeit konzipiert ist. Diese Version der- ServerDocument Klasse kann mit Projektmappen verwendet werden, die mithilfe von erstellt werden Visual Studio 2013 , Visual Studio 2010 und mit 2007-Microsoft Office Lösungen, die mit Visual Studio 2008 erstellt werden.

In der folgenden Tabelle wird die Bedeutung der Rückgabewerte für diese Methode angegeben.

Rückgabewert Beschreibung
0 Das Dokument enthält keine Anpassung.
1 Das Dokument verfügt über eine Anpassung, die mit Visual Studio-Tools für Office, Version 2003, erstellt wurde.
2 Das Dokument verfügt über eine Anpassung, die mit der Visual Studio 2005-Tools für Office Second Edition-Laufzeit erstellt wurde. Dies ist die Version der Laufzeit, die von Anpassungen für Microsoft Office 2003 in Visual Studio 2005-Tools für Office und Visual Studio 2008 verwendet wird.
3 Das Dokument enthält eine Anpassung, die mithilfe der Visual Studio 2010-Tools für Office-Laufzeit oder der Visual Studio-Tools für das Microsoft Office System (Version 3,0 Runtime) erstellt wurde. Version 3,0 der Laufzeit wird von Anpassungen für das 2007-Microsoft Office System in Visual Studio 2008 verwendet.

Weitere Informationen zu den verschiedenen Versionen von finden Sie unter Visual Studio-Tools für Office-Laufzeit Visual Studio-Tools for Office Runtime Overview.

Gilt für