ServerDocument コンストラクター

リファレンス

定義

名前空間:: Microsoft.VisualStudio.Tools.Applications

アセンブリ:: Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

ServerDocument(String)	読み込むドキュメントの完全パスを使用して、ServerDocument クラスの新しいインスタンスを初期化します。
ServerDocument(Byte[], String)	読み込むドキュメントを表すバイト配列およびドキュメントのファイル名拡張子を使用して、ServerDocument クラスの新しいインスタンスを初期化します。
ServerDocument(Stream, String)	読み込むドキュメントを表すストリームおよびドキュメントのファイル名拡張子を使用して、ServerDocument クラスの新しいインスタンスを初期化します。
ServerDocument(String, FileAccess)	読み込むドキュメントの完全パス、およびドキュメントのファイルアクセスを示す値を使用して、ServerDocument クラスの新しいインスタンスを初期化します。

ServerDocument(String)

読み込むドキュメントの完全パスを使用して、ServerDocument クラスの新しいインスタンスを初期化します。

public:
 ServerDocument(System::String ^ documentPath);

public ServerDocument (string documentPath);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : string -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (documentPath As String)

パラメーター

documentPath: String

読み込むドキュメントの完全パスです。

例外

ArgumentNullException

documentPath パラメーターは、null または空であるか、または空白文字から構成されます。

FileNotFoundException

documentPath で指定されたファイルが存在しません。

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 ランタイムでサポートされていないファイル名拡張子があります。

例

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

この例で必要な要素は次のとおりです。

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

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

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

注釈

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

適用対象

ServerDocument(Byte[], String)

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

public:
 ServerDocument(cli::array <System::Byte> ^ bytes, System::String ^ fileType);

public ServerDocument (byte[] bytes, string fileType);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : byte[] * string -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (bytes As Byte(), fileType As String)

パラメーター

bytes: Byte[]

読み込むドキュメントを表すバイト配列。

fileType: String

パラメーターに格納されているドキュメントのファイル名拡張子の bytes 前にピリオド (.) が付きます。".xlsx" や ".docx" などです。

例外

ArgumentNullException

bytesパラメーターが null または empty です。または- fileType パラメーターがnullまたは空であるか、空白文字で構成されています。

UnknownCustomizationFileException

パラメーターはfileType、Visual Studio Tools for Office ランタイムでサポートされていないファイル名拡張子を指定します。

DocumentCustomizedWithPreviousRuntimeException

例

次のコード例では、[ServerDocument コンストラクター (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.%23ctor%28System.Byte%5B%5D%2CSystem) を使用しますファイル名拡張子が .xlsx Excel ブックを含むバイト配列から新しい [ServerDocument コンストラクター (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument>) を作成する.String%29> コンストラクター。次に、[ServerDocument コンストラクター (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> プロパティ) を使用して、ドキュメント内のバイト数を表示します。

この例で必要な要素は次のとおりです。

コンソールアプリケーションプロジェクトまたはその他の Office 以外のプロジェクト。
次のアセンブリへの参照:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll と Microsoft.VisualStudio.Tools.Applications.Runtime.dll (プロジェクトが.NET Framework 4 または.NET Framework 4.5 を対象とする場合)。
  
  または
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll して Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll します (プロジェクトが.NET Framework 3.5 を対象とする場合)。
Imports (Visual Basic の場合) または using [ServerDocument コンストラクター (Byte<xref:Microsoft.VisualStudio.Tools.Applications?displayProperty=fullName> ]、および [ServerDocument コンストラクター (Byte<xref:Microsoft.VisualStudio.Tools.Applications.Runtime?displayProperty=fullName> 名前空間) のステートメント。コードファイルの上部にあります。

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

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            // Read the file into a byte array.
            stream = new System.IO.FileStream(
                documentPath, System.IO.FileMode.Open,
                System.IO.FileAccess.Read);
            byte[] buffer = new byte[(int)stream.Length];
            stream.Read(buffer, 0, (int)buffer.Length);

            // Display the number of bytes in the document.
            serverDocument1 = new ServerDocument(buffer,
                "*.xlsx");
            MessageBox.Show("The Document property contains " +
                serverDocument1.Document.Length.ToString() +
                " bytes.");
        }
    }
    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();
    }
}

Private Sub CreateServerDocumentFromByteArray(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
            ' Read the file into a byte array.
            stream = New System.IO.FileStream(documentPath, System.IO.FileMode.Open, _
                System.IO.FileAccess.Read)
            Dim buffer(Fix(stream.Length)) As Byte
            stream.Read(buffer, 0, Fix(buffer.Length))

            ' Display the number of bytes in the document.
            serverDocument1 = New ServerDocument(buffer, "*.xlsx")
            MessageBox.Show("The Document property contains " & _
                serverDocument1.Document.Length.ToString() & " bytes.")
        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

注釈

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

パラメーターは fileType 、バイト配列に格納されているドキュメントの種類を決定するためにのみ使用されます。の fileType 値は、ドキュメントレベルのカスタマイズでサポートされているファイルの種類のいずれかにマップされます。ファイルを開く試みは行われません。必要に応じて完全なファイル名 ("Workbook1.xlsx" など) を渡すことができますが、これを行う場合は、ファイル名拡張子のみが使用されます。サポートされているファイルの種類の詳細については、「 Document-Level カスタマイズのアーキテクチャ」を参照してください。

このコンストラクターを呼び出した後でドキュメントのバイト配列にアクセスするには、[ServerDocument コンストラクター (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> プロパティ) を使用します。

適用対象

ServerDocument(Stream, String)

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

public:
 ServerDocument(System::IO::Stream ^ stream, System::String ^ fileType);

public ServerDocument (System.IO.Stream stream, string fileType);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : System.IO.Stream * string -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (stream As Stream, fileType As String)

パラメーター

stream: Stream

読み込むドキュメントを表すストリームです。

fileType: String

パラメーターに格納されているドキュメントのファイル名拡張子の bytes 前にピリオド (.) が付きます。".xlsx" や ".docx" などです。

例外

ArgumentNullException

streamパラメーターが null または empty です。または- fileType パラメーターがnullまたは空であるか、空白文字で構成されています。

ArgumentException

stream パラメーターが長さ 0 であるか、その現在位置がストリームの最後になっています。

UnknownCustomizationFileException

パラメーターはfileType、Visual Studio Tools for Office ランタイムでサポートされていないファイル名拡張子を指定します。

DocumentCustomizedWithPreviousRuntimeException

例

次のコード例では、コンストラクターを ServerDocument(Stream, String) 使用して、.xlsx ファイル名拡張子を持つ Excel ブックを含むから新しい ServerDocument FileStream を作成します。次に、ドキュメントに添付されているカスタマイズの配置マニフェストの URL が表示されます。

この例で必要な要素は次のとおりです。

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

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

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

注釈

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

適用対象

ServerDocument(String, FileAccess)

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

public:
 ServerDocument(System::String ^ documentPath, System::IO::FileAccess access);

public ServerDocument (string documentPath, System.IO.FileAccess access);

new Microsoft.VisualStudio.Tools.Applications.ServerDocument : string * System.IO.FileAccess -> Microsoft.VisualStudio.Tools.Applications.ServerDocument

Public Sub New (documentPath As String, access As FileAccess)

パラメーター

documentPath: String

読み込むドキュメントの完全パスです。

access: FileAccess

ドキュメントのファイルアクセスを示す値です。

例外

ArgumentNullException

documentPath パラメーターは、null または空であるか、または空白文字から構成されます。

ArgumentException

の access 値は System.IO.FileAccess.Write です。

FileNotFoundException

documentPath で指定されたファイルが存在しません。

DocumentNotCustomizedException

パラメーターで documentPath 指定されたファイルはカスタマイズされておらず、の access 値は System.IO.FileAccess.Read です。

DocumentCustomizedWithPreviousRuntimeException

UnknownCustomizationFileException

でdocumentPath指定されたファイルには、Visual Studio Tools for Office ランタイムでサポートされていないファイル名拡張子があります。

例

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

この例で必要な要素は次のとおりです。

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

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

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

注釈

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

適用対象

次の方法で共有

ServerDocument コンストラクター

定義

オーバーロード

ServerDocument(String)

パラメーター

例外

例

注釈

適用対象

ServerDocument(Byte[], String)

パラメーター

例外

例

注釈

適用対象

ServerDocument(Stream, String)

パラメーター

例外

例

注釈

適用対象

ServerDocument(String, FileAccess)

パラメーター

例外

例

注釈

適用対象

その他のリソース