ServerDocument.GetCustomizationVersion-Methode (2007 System)

Článek
08/23/2008

Aktualisiert: November 2007

Gibt die Version der 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.v9.0 (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll)

Syntax

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

returnValue = ServerDocument.GetCustomizationVersion(documentPath)

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 der 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 unterstützt wird.

Hinweise

Visual Studio Tools for Office-Projektmappen für Microsoft Office 2003 und 2007 Microsoft Office System verwenden verschiedene Versionen der Visual Studio Tools for Office-Laufzeit. 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 nur mit Projektmappen verwendet werden, die mit Projektvorlagen auf Dokumentebene für Word 2007 und Excel 2007 erstellt wurden.

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

Rückgabewert	Beschreibung
0	Das Dokument besitzt keine Visual Studio Tools for Office-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 Laufzeit für Visual Studio 2005 Tools for Office Second Edition erstellt wurde. Hierbei handelt es sich um die Version der Laufzeit, die zum Erstellen von Anpassungen für Microsoft Office 2003 verwendet wird.
3	Das Dokument verfügt über eine Anpassung, die mit Microsoft Visual Studio Tools für Microsoft Office System (Version 3.0-Laufzeit) erstellt wurde. Hierbei handelt es sich um die Version der Laufzeit, die zum Erstellen von Anpassungen für 2007 Microsoft Office System verwendet wird.

Weitere Informationen zu den unterschiedlichen Versionen der ServerDocument-Klasse finden Sie unter Verwalten von Dokumenten auf einem Server mit der ServerDocument-Klasse. Ein Codebeispiel, das veranschaulicht, wie diese Methode mit verschiedenen Versionen der ServerDocument-Klasse in derselben Codedatei verwendet werden kann, finden Sie unter Gewusst wie: Schreiben von Code, der beide Versionen der ServerDocument-Klasse verwendet.

Weitere Informationen zu den unterschiedlichen 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 Visual Studio Tools for Office-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 Microsoft Visual Studio Tools für Microsoft Office System (Version 3.0-Laufzeit) erstellt wurde. Dies ist die einzige Laufzeit, mit der diese Version der ServerDocument-Klasse kompatibel ist.

Für dieses Beispiel ist am Anfang der Codedatei ein Verweis auf die Assemblys Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll sowie auf die Anweisung Imports (für Visual Basic) oder using (für C#) für die Namespaces Microsoft.VisualStudio.Tools.Applications und Microsoft.VisualStudio.Tools.Applications.Runtime erforderlich.

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

Berechtigungen

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.