ServerDocument.GetCustomizationVersion メソッド (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

指定されたドキュメントに関連付けられているカスタマイズの作成に使用した Visual Studio Tools for Office ランタイムのバージョンを返します。

名前空間 : Microsoft.VisualStudio.Tools.Applications
アセンブリ : Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0 (Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll 内)

構文

'宣言
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer
'使用
Dim documentPath As String
Dim returnValue As Integer

returnValue = ServerDocument.GetCustomizationVersion(documentPath)

public static int GetCustomizationVersion(
    string documentPath
)

パラメータ

documentPath
型 : System.String

確認するドキュメントの完全パスです。

戻り値

型 : System.Int32

関連付けられているカスタマイズの作成に使用した Visual Studio Tools for Office ランタイムのバージョンを指定する数値です。

例外

例外	条件
ArgumentNullException	documentPath パラメータは、nullnull 参照 (Visual Basic では Nothing) または空であるか、または空白文字から構成されます。
FileNotFoundException	documentPath で指定されたファイルが存在しません。
UnknownCustomizationFileException	documentPath で指定されたファイルで、Visual Studio Tools for Office でサポートされていないファイル名の拡張子が使用されています。

解説

Microsoft Office 2003 および 2007 Microsoft Office system の Visual Studio Tools for Office ソリューションは、さまざまなバージョンの Visual Studio Tools for Office ランタイムを使用します。各バージョンのランタイムは、そのランタイムバージョンに対応したソリューションで機能するように設計された、それぞれ異なるバージョンの ServerDocument クラスを提供します。このバージョンの ServerDocument クラスは、Word 2007 と Excel 2007 のドキュメントレベルのプロジェクトテンプレートを使用して作成されたソリューションでのみ使用できます。

このメソッドの戻り値の意味を次の表に示します。

戻り値	説明
0	ドキュメントに Visual Studio Tools for Office カスタマイズが含まれていません。
1	ドキュメントに、Visual Studio Tools for Office Version 2003 を使用して作成されたカスタマイズが含まれます。
2	ドキュメントに、Visual Studio 2005 Tools for Office Second Edition Runtime を使用して作成されたカスタマイズが含まれます。これは、Microsoft Office 2003 のカスタマイズの作成に使用されたランタイムのバージョンです。
3	ドキュメントに、Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) を使用して作成されたカスタマイズが含まれます。これは、2007 Microsoft Office system のカスタマイズの作成に使用されたランタイムのバージョンです。

さまざまなバージョンの ServerDocument クラスの詳細については、「ServerDocument クラスによるサーバー上のドキュメントの管理」を参照してください。同じコードファイルにある ServerDocument クラスの異なるバージョンで機能するようにこのメソッドを使用する方法を示すコード例については、「方法 : ServerDocument クラスの両方のバージョンを使用するコードを記述する」を参照してください。

さまざまなバージョンの Visual Studio Tools for Office ランタイムの詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。

例

次のコード例は、指定のドキュメントを読み込む新しい ServerDocument を作成し、ドキュメントにアタッチされた Visual Studio Tools for Office カスタマイズの配置マニフェストの URL を表示します。オブジェクトを作成する前に、コードは GetCustomizationVersion メソッドを使用して、Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) を使用して作成されたカスタマイズであることを検証します。これは、このバージョンの ServerDocument クラスと互換性のある唯一のランタイムです。

この例では、Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll アセンブリと Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll アセンブリへの参照、およびコードファイルの先頭に記述された Microsoft.VisualStudio.Tools.Applications 名前空間および Microsoft.VisualStudio.Tools.Applications.Runtime 名前空間に対する Imports ステートメント (Visual Basic の場合) または using ステートメント (C# の場合) が必要です。

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