ServerDocument Konstruktoren

Definition

Überlädt

ServerDocument(String)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei den vollständigen Pfad zu dem Dokument, das geladen werden soll.

ServerDocument(Byte[], String)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei ein Bytearray, welches das zu ladende Dokument darstellt, sowie die Dateinamenerweiterung des Dokuments.

ServerDocument(Stream, String)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei einen Stream, der das zu ladende Dokument darstellt, sowie die Dateinamenerweiterung des Dokuments.

ServerDocument(String, FileAccess)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei den vollständigen Pfad zu dem Dokument, das geladen werden soll, sowie einen Wert, der den Dateizugriff für das Dokument angibt.

ServerDocument(String)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei den vollständigen Pfad zu dem Dokument, das geladen werden soll.

public ServerDocument (string documentPath);

Parameter

documentPath
String

Der vollständige Pfad des Dokuments, das geladen werden soll.

Ausnahmen

Der documentPath-Parameter ist entweder null oder leer, oder er besteht nur aus Leerzeichen.

Die Datei, die unter documentPath angegeben ist, ist nicht vorhanden.

Die Datei, die unter documentPath angegeben ist, verfügt über eine Anpassung, die nicht mit Visual Studio 2010-Tools für Office Runtime oder Visual Studio Tools for Microsoft Office System (Version 3.0, Laufzeit) erstellt wurde.

Die in documentPath angegebene Datei hat eine Dateinamenerweiterung, die nicht von Visual Studio-Tools für Office-Laufzeit unterstützt wird.

Beispiele

Im folgenden Codebeispiel wird der- ServerDocument(String) Konstruktor verwendet, um eine neue zu erstellen ServerDocument , die ein angegebenes Dokument lädt. Im Beispiel wird dann die URL des Bereitstellungs Manifests für die Anpassung angezeigt, die an das Dokument angefügt wird.

Für dieses Beispiel benötigen Sie Folgendes:

  • Ein Konsolen Anwendungsprojekt oder ein anderes nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt .NET Framework 4 oder .NET Framework 4.5 als Ziel hat).

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf die .NET Framework 3,5) abzielt.

  • Imports(für Visual Basic) oder using (für c#)-Anweisungen für Microsoft.VisualStudio.Tools.Applications -und- Microsoft.VisualStudio.Tools.Applications.Runtime Namespaces am Anfang der Codedatei.

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

Hinweise

Verwenden Sie diesen Konstruktor, um auf die Informationen zwischengespeicherten Daten oder Bereitstellungs Manifest in einem Dokument zuzugreifen, das sich auf dem Datenträger befindet Wenn Sie diesen Konstruktor verwenden, wird das angegebene Dokument mit Lese-/Schreibzugriff geöffnet.

Gilt für

ServerDocument(Byte[], String)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei ein Bytearray, welches das zu ladende Dokument darstellt, sowie die Dateinamenerweiterung des Dokuments.

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

Parameter

bytes
Byte[]

Ein Bytearray, welches das Dokument darstellt, das geladen werden soll.

fileType
String

Die Dateinamenerweiterung des Dokuments, die im bytes-Parameter gespeichert ist und der ein Punkt (.) vorangestellt wird, z.B. „.xlsx“ oder „.docx“.

Ausnahmen

Der bytes-Parameter ist null oder leer.

- oder - Der fileType-Parameter ist entweder null oder leer, oder er besteht nur aus Leerzeichen.

Der fileType-Parameter gibt eine Dateinamenerweiterung an, die nicht von Visual Studio-Tools für Office-Laufzeit unterstützt wird.

Die Datei, die unter documentPath angegeben ist, verfügt über eine Anpassung, die nicht mit Visual Studio 2010-Tools für Office Runtime oder Visual Studio Tools for Microsoft Office System (Version 3.0, Laufzeit) erstellt wurde.

Beispiele

Im folgenden Codebeispiel wird der [ServerDocument-Konstruktor (Byte- <xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.%23ctor%28System.Byte%5B%5D%2CSystem.String%29> Konstruktor verwendet, um einen neuen [ServerDocument-Konstruktor zu erstellen (Byte <xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument> aus einem Bytearray, das eine Excel-Arbeitsmappe mit der Dateinamenerweiterung. xlsx enthält). Im Beispiel wird dann der [ServerDocument-Konstruktor (Byte- <xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> Eigenschaft verwendet, um die Anzahl der Bytes im Dokument anzuzeigen.

Für dieses Beispiel benötigen Sie Folgendes:

  • Ein Konsolen Anwendungsprojekt oder ein anderes nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt .NET Framework 4 oder .NET Framework 4.5 als Ziel hat).

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf die .NET Framework 3,5) abzielt.

  • Imports(für Visual Basic) oder using (für c#)-Anweisungen für [ServerDocument-Konstruktor (Byte <xref:Microsoft.VisualStudio.Tools.Applications?displayProperty=fullName> und [ServerDocument-Konstruktor (Byte- <xref:Microsoft.VisualStudio.Tools.Applications.Runtime?displayProperty=fullName> Namespaces am Anfang der Codedatei).

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

Hinweise

Verwenden Sie diesen Konstruktor, um auf die Informationen zwischengespeicherten Daten oder Bereitstellungs Manifest in einem Dokument zuzugreifen, das sich bereits im Arbeitsspeicher befindet. Wenn Sie diesen Konstruktor verwenden, wird das Dokument mit Lese-/Schreibzugriff geöffnet.

Der- fileType Parameter wird nur verwendet, um den im Bytearray gespeicherten Dokumenttyp zu bestimmen. Der Wert von fileType wird einem der Dateitypen zugeordnet, die für Anpassungen auf Dokument Ebene unterstützt werden. Es wird nicht versucht, die Datei zu öffnen. Optional können Sie einen kompletten Dateinamen übergeben (z. b. "Workbook1.xlsx"), aber wenn Sie dies tun, wird nur die Dateinamenerweiterung verwendet. Weitere Informationen zu den unterstützten Dateitypen finden Sie unter Architektur von Anpassungen auf Dokument Ebene.

Um nach dem Aufruf dieses Konstruktors auf das Bytearray für das Dokument zuzugreifen, verwenden Sie den [ServerDocument-Konstruktor (Byte- <xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> Eigenschaft).

Gilt für

ServerDocument(Stream, String)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei einen Stream, der das zu ladende Dokument darstellt, sowie die Dateinamenerweiterung des Dokuments.

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

Parameter

stream
Stream

Ein Stream, der das Dokument darstellt, das geladen werden soll.

fileType
String

Die Dateinamenerweiterung des Dokuments, die im bytes-Parameter gespeichert ist und der ein Punkt (.) vorangestellt wird, z.B. „.xlsx“ oder „.docx“.

Ausnahmen

Der stream-Parameter ist null oder leer.

- oder - Der fileType-Parameter ist entweder null oder leer, oder er besteht nur aus Leerzeichen.

Der stream-Parameter besitzt die Länge 0 (null), oder seine aktuelle Position ist am Ende des Streams.

Der fileType-Parameter gibt eine Dateinamenerweiterung an, die nicht von Visual Studio-Tools für Office-Laufzeit unterstützt wird.

Die Datei, die unter documentPath angegeben ist, verfügt über eine Anpassung, die nicht mit Visual Studio 2010-Tools für Office Runtime oder Visual Studio Tools for Microsoft Office System (Version 3.0, Laufzeit) erstellt wurde.

Beispiele

Im folgenden Codebeispiel wird der- ServerDocument(Stream, String) Konstruktor verwendet, um eine neue ServerDocument aus einem zu erstellen FileStream , das eine Excel-Arbeitsmappe mit der Dateinamenerweiterung ". xlsx" enthält. Der Code zeigt dann die URL des Bereitstellungs Manifests für die Anpassung an, die an das Dokument angefügt wird.

Für dieses Beispiel benötigen Sie Folgendes:

  • Ein Konsolen Anwendungsprojekt oder ein anderes nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt .NET Framework 4 oder .NET Framework 4.5 als Ziel hat).

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf die .NET Framework 3,5) abzielt.

  • Imports(für Visual Basic) oder using (für c#)-Anweisungen für Microsoft.VisualStudio.Tools.Applications -und- Microsoft.VisualStudio.Tools.Applications.Runtime Namespaces am Anfang der Codedatei.

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

Hinweise

Verwenden Sie diesen Konstruktor, um auf die Informationen zwischengespeicherten Daten oder Bereitstellungs Manifest in einem Dokument zuzugreifen, das sich bereits im Arbeitsspeicher befindet. Wenn Sie diesen Konstruktor verwenden, wird das Dokument mit Lese-/Schreibzugriff geöffnet.

Der- fileType Parameter wird nur verwendet, um den im Bytearray gespeicherten Dokumenttyp zu bestimmen. Der Wert von fileType wird einem der Dateitypen zugeordnet, die für Anpassungen auf Dokument Ebene unterstützt werden. Es wird nicht versucht, die Datei zu öffnen. Optional können Sie einen kompletten Dateinamen übergeben (z. b. "Workbook1.xlsx"), aber wenn Sie dies tun, wird nur die Dateinamenerweiterung verwendet. Weitere Informationen zu den unterstützten Dateitypen finden Sie unter Architektur von Anpassungen auf Dokument Ebene.

Wenn Sie nach dem Aufruf dieses Konstruktors auf das Bytearray für das Dokument zugreifen möchten, verwenden Sie die- Document Eigenschaft.

Gilt für

ServerDocument(String, FileAccess)

Initialisiert eine neue Instanz der ServerDocument-Klasse und verwendet dabei den vollständigen Pfad zu dem Dokument, das geladen werden soll, sowie einen Wert, der den Dateizugriff für das Dokument angibt.

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

Parameter

documentPath
String

Der vollständige Pfad des Dokuments, das geladen werden soll.

access
FileAccess

Ein Wert, der den Dateizugriff für das Dokument angibt.

Ausnahmen

Der documentPath-Parameter ist entweder null oder leer, oder er besteht nur aus Leerzeichen.

Der Wert von access ist System.IO.FileAccess.Write.

Die Datei, die unter documentPath angegeben ist, ist nicht vorhanden.

Die im documentPath-Parameter angegebene Datei hat keine Anpassung, und der Wert von access ist System.IO.FileAccess.Read.

Die Datei, die unter documentPath angegeben ist, verfügt über eine Anpassung, die nicht mit Visual Studio 2010-Tools für Office Runtime oder Visual Studio Tools for Microsoft Office System (Version 3.0, Laufzeit) erstellt wurde.

Die in documentPath angegebene Datei hat eine Dateinamenerweiterung, die nicht von Visual Studio-Tools für Office-Laufzeit unterstützt wird.

Beispiele

Im folgenden Codebeispiel wird der- ServerDocument(String, FileAccess) Konstruktor verwendet, um eine neue zu erstellen ServerDocument , die ein angegebenes Dokument mit Schreib geschütztem Zugriff lädt. Der Code zeigt dann die URL des Bereitstellungs Manifests für die Anpassung an, die an das Dokument angefügt wird.

Für dieses Beispiel benötigen Sie Folgendes:

  • Ein Konsolen Anwendungsprojekt oder ein anderes nicht-Office-Projekt.

  • Verweise auf die folgenden Assemblys:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.dll (wenn das Projekt .NET Framework 4 oder .NET Framework 4.5 als Ziel hat).

      oder

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll und Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (wenn das Projekt auf die .NET Framework 3,5) abzielt.

  • Imports(für Visual Basic) oder using (für c#)-Anweisungen für Microsoft.VisualStudio.Tools.Applications -und- Microsoft.VisualStudio.Tools.Applications.Runtime Namespaces am Anfang der Codedatei.

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

Hinweise

Verwenden Sie diesen Konstruktor, um auf die Informationen zwischengespeicherten Daten oder Bereitstellungs Manifest in einem Dokument zuzugreifen, das sich auf dem Datenträger befindet, wenn Sie das Dokument mit Schreib geschütztem oder Schreib geschütztem Zugriff öffnen möchten. Standardmäßig öffnen die anderen ServerDocument Konstruktoren das Dokument mit Lese-/Schreibzugriff.

Gilt für