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

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

読み込むドキュメントを表すストリームおよびドキュメントのファイル名拡張子を使用して、ServerDocument クラスの新しいインスタンスを初期化します。

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

構文

'宣言
Public Sub New ( _
    stream As Stream, _
    fileType As String _
)

public ServerDocument(
    Stream stream,
    string fileType
)

パラメーター

stream
型: System.IO.Stream
読み込むドキュメントを表すストリームです。

fileType
型: System.String
bytes パラメーターに格納されるドキュメントのファイル名の拡張子です。拡張子の前にはピリオド (.) が付きます。たとえば、".xlsx" や ".docx" のようになります。

例外

例外	条件
ArgumentNullException	stream パラメーターが nullnull 参照 (Visual Basic では Nothing) または空です。または fileType パラメーターは、nullnull 参照 (Visual Basic では Nothing) または空であるか、または空白文字から構成されます。
ArgumentException	stream パラメーターが長さ 0 であるか、その現在位置がストリームの最後になっています。
UnknownCustomizationFileException	fileType パラメーターは、Visual Studio Tools for Office Runtime ではサポートされないファイル名拡張子を指定します。
DocumentCustomizedWithPreviousRuntimeException	documentPath で指定されたファイルには、Visual Studio 2010 Tools for Office Runtime または Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) 以外で作成されたカスタマイズが含まれています。

解説

このコンストラクターを使用して、メモリ内に既に存在するドキュメントのキャッシュされたデータや配置マニフェスト情報にアクセスします。このコンストラクターを使用すると、ドキュメントは読み取り/書き込みアクセスで開かれます。

fileType パラメーターは、バイト配列に保存されているドキュメントの種類を指定するためにのみ使用されます。 fileType の値は、ドキュメントレベルのカスタマイズでサポートされるいずれかのファイルの種類にマップされます。ファイルは開かれません。完全なファイル名 (たとえば、"Workbook1.xlsx" など) を渡すこともできますが、このように操作しても、使用されるのはファイル名の拡張子だけです。サポートされるファイルの種類の詳細については、「ドキュメントレベルのカスタマイズのアーキテクチャ」を参照してください。

このコンストラクターを呼び出した後、ドキュメントのバイト配列にアクセスするには、Document プロパティを使用します。

例

次のコード例は、ServerDocument(Stream, String) コンストラクターを使用して、.xlsx ファイル名拡張子が設定された Excel ブックを含む FileStream から新しい 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 CreateServerDocumentFromStream(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing
    Dim stream As System.IO.FileStream = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            stream = New System.IO.FileStream(documentPath, System.IO.FileMode.Open)
            serverDocument1 = New ServerDocument(stream, "*.xlsx")
            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
        If Not (stream Is Nothing) Then
            stream.Close()
        End If
    End Try
End Sub

private void CreateServerDocumentFromStream(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;
    System.IO.FileStream stream = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            stream = new System.IO.FileStream(
                documentPath, System.IO.FileMode.Open);
            serverDocument1 = new ServerDocument(stream,
                "*.xlsx");
            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();
        if (stream != null)
            stream.Close();
    }
}