ServerDocument Konstruktoren

Referenz

Definition

Namespace:: Microsoft.VisualStudio.Tools.Applications

Assembly:: Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ü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(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)

Parameter

documentPath: String

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

Ausnahmen

ArgumentNullException

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

FileNotFoundException

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

DocumentCustomizedWithPreviousRuntimeException

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.

UnknownCustomizationFileException

Die von documentPath angegebene Datei verfügt über eine Dateinamenerweiterung, die von der Visual Studio-Tools für Office Runtime nicht unterstützt wird.

Beispiele

Im folgenden Codebeispiel wird der ServerDocument(String) Konstruktor verwendet, um einen neuen ServerDocument zu erstellen, der ein angegebenes Dokument lädt. Im Beispiel wird dann die URL des Bereitstellungsmanifests für die Anpassung angezeigt, die dem Dokument angefügt ist.

Für dieses Beispiel benötigen Sie Folgendes:

Ein Konsolenanwendungsprojekt 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 auf die .NET Framework 4 oder die .NET Framework 4.5 abzielt).
  
  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 zwischengespeicherten Daten oder Bereitstellungsmanifestinformationen 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(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)

Parameter

bytes: Byte[]

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

fileType: String

Die Dateinamenerweiterung des Dokuments, das im bytes Parameter gespeichert ist, vor dem ein Punkt (.) – z. B. ".xlsx" oder ".docx".

Ausnahmen

ArgumentNullException

Der bytes Parameter ist null oder leer.-or-Der fileType Parameter ist null leer oder besteht vollständig aus Leerzeichen.

UnknownCustomizationFileException

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

DocumentCustomizedWithPreviousRuntimeException

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 (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument)> aus einem Bytearray zu erstellen, das eine Excel-Arbeitsmappe mit der .xlsx Dateinamenerweiterung enthält. Im Beispiel wird dann die [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 Konsolenanwendungsprojekt 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 auf die .NET Framework 4 oder die .NET Framework 4.5 abzielt).
  
  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 zwischengespeicherten Daten oder Bereitstellungsmanifestinformationen 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 Dokumenttyp zu bestimmen, der im Bytearray gespeichert ist. Der Wert von fileType wird einem der Dateitypen zugeordnet, die für Anpassungen auf Dokumentebene unterstützt werden. Es wird kein Versuch unternommen, die Datei zu öffnen. Sie können optional einen vollständigen Dateinamen (z. B. "Workbook1.xlsx") übergeben, aber in diesem Fall wird nur die Dateinamenerweiterung verwendet. Weitere Informationen zu den unterstützten Dateitypen finden Sie unter Architektur Document-Level Anpassungen.

Um nach dem Aufrufen 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, 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)

Parameter

stream: Stream

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

fileType: String

Die Dateinamenerweiterung des Dokuments, das im bytes Parameter gespeichert ist, vor dem ein Punkt (.) – z. B. ".xlsx" oder ".docx".

Ausnahmen

ArgumentNullException

Der stream Parameter ist null oder leer.-or-Der fileType Parameter ist null leer oder besteht vollständig aus Leerzeichen.

ArgumentException

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

UnknownCustomizationFileException

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

DocumentCustomizedWithPreviousRuntimeException

Beispiele

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

Für dieses Beispiel benötigen Sie Folgendes:

Ein Konsolenanwendungsprojekt 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 auf die .NET Framework 4 oder die .NET Framework 4.5 abzielt).
  
  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 die -Eigenschaft, um nach dem Aufrufen dieses Konstruktors auf das Bytearray für das Document Dokument zuzugreifen.

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

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

ArgumentNullException

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

ArgumentException

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

FileNotFoundException

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

DocumentNotCustomizedException

Die durch den documentPath -Parameter angegebene Datei verfügt nicht über eine Anpassung, und der Wert von access ist System.IO.FileAccess.Read.

DocumentCustomizedWithPreviousRuntimeException

UnknownCustomizationFileException

Die von documentPath angegebene Datei verfügt über eine Dateinamenerweiterung, die von der Visual Studio-Tools für Office Runtime nicht unterstützt wird.

Beispiele

Im folgenden Codebeispiel wird der ServerDocument(String, FileAccess) Konstruktor verwendet, um einen neuen ServerDocument zu erstellen, der ein angegebenes Dokument mit schreibgeschütztem Zugriff lädt. Der Code zeigt dann die URL des Bereitstellungsmanifests für die Anpassung an, die dem Dokument angefügt ist.

Für dieses Beispiel benötigen Sie Folgendes:

Ein Konsolenanwendungsprojekt 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 auf die .NET Framework 4 oder die .NET Framework 4.5 abzielt).
  
  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 zwischengespeicherten Daten oder Bereitstellungsmanifestinformationen in einem Dokument zuzugreifen, das sich auf dem Datenträger befindet, wenn Sie das Dokument mit schreibgeschütztem oder schreibgeschütztem Zugriff öffnen möchten. Standardmäßig öffnen die anderen ServerDocument Konstruktoren das Dokument mit Lese-/Schreibzugriff.

Gilt für:

Freigeben über

ServerDocument Konstruktoren

Definition

Überlädt

ServerDocument(String)

Parameter

Ausnahmen

Beispiele

Hinweise

Gilt für:

ServerDocument(Byte[], String)

Parameter

Ausnahmen

Beispiele

Hinweise

Gilt für:

ServerDocument(Stream, String)

Parameter

Ausnahmen

Beispiele

Hinweise

Gilt für:

ServerDocument(String, FileAccess)

Parameter

Ausnahmen

Beispiele

Hinweise

Gilt für:

Zusätzliche Ressourcen