ServerDocument コンストラクター (String, FileAccess)

[アーティクル]
08/09/2011

読み込むドキュメントの完全パス、およびドキュメントのファイルアクセスを示す値を使用して、ServerDocument クラスの新しいインスタンスを初期化します。

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

構文

'宣言
Public Sub New ( _
    documentPath As String, _
    access As FileAccess _
)

public ServerDocument(
    string documentPath,
    FileAccess access
)

パラメーター

documentPath
型: System.String
読み込むドキュメントの完全パスです。

access
型: System.IO.FileAccess
ドキュメントのファイルアクセスを示す値です。

例外

例外	条件
ArgumentNullException	documentPath パラメーターは、nullnull 参照 (Visual Basic では Nothing) または空であるか、または空白文字から構成されます。
ArgumentException	access の値が System.IO.FileAccess.Write です。
FileNotFoundException	documentPath で指定されたファイルが存在しません。
DocumentNotCustomizedException	documentPath パラメーターで指定されたファイルにカスタマイズが含まれず、access の値が System.IO.FileAccess.Read です。
DocumentCustomizedWithPreviousRuntimeException	documentPath で指定されたファイルには、Visual Studio 2010 Tools for Office Runtime または Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) 以外で作成されたカスタマイズが含まれています。
UnknownCustomizationFileException	documentPath で指定されたファイルで、Visual Studio Tools for Office Runtime でサポートされていないファイル名の拡張子が使用されています。

解説

読み取り専用または書き込み専用のアクセスでドキュメントを開くには、このコンストラクターを使用して、ディスク上にあるドキュメントのキャッシュされたデータまたは配置マニフェスト情報にアクセスします。既定では、他の ServerDocument コンストラクターは、ドキュメントを読み取り/書き込みアクセスで開きます。

例

次のコード例は、ServerDocument(String, FileAccess) コンストラクターを使用して、指定したドキュメントを読み取り専用アクセスで読み込むための新しい ServerDocument を作成します。次に、このコードは、ドキュメントにアタッチされたカスタマイズの配置マニフェストの URL を表示します。

この例には、次の項目が必要です。

コンソールアプリケーションプロジェクトまたはその他の Office 以外のプロジェクト。
次のアセンブリへの参照。
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll および Microsoft.VisualStudio.Tools.Applications.Runtime.dll (プロジェクトが .NET Framework 4 を対象とする場合)。
  
  または
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll および Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (プロジェクトが .NET Framework 3.5 を対象とする場合)。
コードファイルの先頭に、Microsoft.VisualStudio.Tools.Applications 名前空間および Microsoft.VisualStudio.Tools.Applications.Runtime 名前空間に対する Imports ステートメント (Visual Basic の場合) または using ステートメント (C# の場合) を追加します。

Private Sub CreateServerDocumentReadOnly(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, System.IO.FileAccess.Read)
            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 DocumentNotCustomizedException
        System.Windows.Forms.MessageBox.Show("The specified document does not " & _
            "have a customization.")
    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 CreateServerDocumentReadOnly(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            serverDocument1 = new ServerDocument(documentPath,
                System.IO.FileAccess.Read);
            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 (DocumentNotCustomizedException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not " +
            "have a customization.");
    }
    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();
    }
}