Freigeben über

ServerDocument.GetCustomizationVersion-Methode

  • Artikel

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

Namespace:  Microsoft.VisualStudio.Tools.Applications
Assembly:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntax

'Declaration
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer

public static int GetCustomizationVersion(
    string documentPath
)

Parameter

  • documentPath
    Typ: System.String
    Der vollständige Pfad zu dem Dokument, das Sie überprüfen möchten.

Rückgabewert

Typ: System.Int32
Eine Zahl, die die Version von Visual Studio Tools for Office-Laufzeit angibt, die zum Erstellen der zugeordneten Anpassung verwendet wurde.

Ausnahmen

Ausnahme Bedingung
ArgumentNullException

Der documentPath-Parameter ist entweder nullNULL-Verweis (Nothing in Visual Basic) oder leer, oder er besteht nur aus Leerzeichen.
FileNotFoundException

Die in documentPath angegebene Datei ist nicht vorhanden.
UnknownCustomizationFileException

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

Hinweise

Office-Projektmappen haben andere Versionen des Visual Studio Tools for Office-Laufzeit in anderen Versionen der Visual Studio-Verwendung erstellt. Jede Version der Laufzeit stellt eine andere Version der ServerDocument-Klasse bereit, die speziell für die Projektmappen der jeweiligen Version der Laufzeit vorgesehen sind. Diese Version der ServerDocument-Klasse kann mit Projektmappen verwendet werden, die mit Visual Studio 2010 erstellt wurden, und mit 2007 Microsoft Office-Projektmappen, die mit Visual Studio 2008 erstellt wurden.

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

Rückgabewert

Beschreibungen

0

Das Dokument besitzt keine Anpassung.

1

Das Dokument verfügt über eine Anpassung, die mit Visual Studio-Tools for Office, Version 2003 erstellt wurde.

2

Das Dokument bietet eine Anpassung, die mit den Office-Entwicklungstools von Visual Studio 2005 for Office Second Edition Runtime erstellt wurde. Dies ist die Version der Laufzeit, die von Anpassungen für Microsoft Office 2003 in Visual Studio 2005 Tools for Office und Visual Studio 2008 verwendet wird.

3

Das Dokument verfügt über eine Anpassung, die mit Visual Studio 2010-Tools for Office-Laufzeit oder den Visual Studio Tools for Microsoft Office System (Version 3.0 Runtime) erstellt wurde. Version 3.0 der CLR wird von Anpassungen für 2007 Microsoft Office System in Visual Studio 2008 verwendet.

Weitere Informationen zu den verschiedenen Versionen der Visual Studio Tools for Office-Laufzeit finden Sie unter Übersicht über die Visual Studio Tools for Office-Laufzeit.

Beispiele

Im folgenden Codebeispiel wird ein neues ServerDocument erstellt, das ein angegebenes Dokument lädt. Dann wird die URL des Bereitstellungsmanifests für die Anpassung angezeigt, die an das Dokument angefügt ist. Vor dem Erstellen des Objekts überprüft der Code mithilfe der GetCustomizationVersion-Methode, ob die Anpassung mit Visual Studio 2010-Tools for Office-Laufzeit erstellt wurde.

Für dieses Beispiel sind erforderlich:

  • Ein Konsolenanwendungsprojekt 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 auf .NET Framework 4 abzielt)

      oder

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

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

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

.NET Framework-Sicherheit

Siehe auch

Referenz

ServerDocument Klasse

Microsoft.VisualStudio.Tools.Applications-Namespace

Weitere Ressourcen

Verwalten von Dokumenten auf einem Server mit der ServerDocument-Klasse