ServerDocument Costruttori

Riferimento

Definizione

Spazio dei nomi:: Microsoft.VisualStudio.Tools.Applications

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

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Overload

ServerDocument(String)	Inizializza una nuova istanza della classe ServerDocument utilizzando il percorso completo del documento da caricare.
ServerDocument(Byte[], String)	Inizializza una nuova istanza della classe ServerDocument utilizzando una matrice di byte che rappresenta il documento da caricare e l'estensione di file del documento.
ServerDocument(Stream, String)	Inizializza una nuova istanza della classe ServerDocument utilizzando un flusso che rappresenta il documento da caricare e l'estensione di file del documento.
ServerDocument(String, FileAccess)	Inizializza una nuova istanza della classe ServerDocument utilizzando il percorso completo del documento da caricare e un valore indicante l'accesso al file per il documento.

ServerDocument(String)

Inizializza una nuova istanza della classe ServerDocument utilizzando il percorso completo del documento da caricare.

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)

Parametri

documentPath: String

Percorso completo del documento da caricare.

Eccezioni

ArgumentNullException

Il parametro documentPath è null, vuoto, oppure composto unicamente da spazi vuoti.

FileNotFoundException

Il file specificato da documentPath non esiste.

DocumentCustomizedWithPreviousRuntimeException

Il file specificato da documentPath dispone di una personalizzazione non creata con Visual Studio 2010 Tools per Office Runtime o Visual Studio Tools per Microsoft Office System (versione Runtime 3.0).

UnknownCustomizationFileException

Il file specificato da documentPath ha un'estensione di file non supportata dal runtime di Visual Studio Tools per Office.

Esempio

Nell'esempio di codice seguente viene utilizzato il ServerDocument(String) costruttore per creare un nuovo ServerDocument oggetto che carica un documento specificato. Nell'esempio viene quindi visualizzato l'URL del manifesto di distribuzione per la personalizzazione associata al documento.

L'esempio presenta i requisiti seguenti:

Un progetto di applicazione console o un altro progetto non Office.
Riferimenti agli assembly seguenti:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se il progetto è destinato a .NET Framework 4 o .NET Framework 4.5).
  
  oppure
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se il progetto è destinato a .NET Framework 3.5).
Imports (per Visual Basic) o using (per C#) istruzioni per Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime spazi dei nomi all'inizio del file di codice.

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

Commenti

Usare questo costruttore per accedere ai dati memorizzati nella cache o alle informazioni sul manifesto della distribuzione in un documento presente su disco. Quando si utilizza questo costruttore, il documento specificato viene aperto con accesso in lettura/scrittura.

Si applica a

ServerDocument(Byte[], String)

Inizializza una nuova istanza della classe ServerDocument utilizzando una matrice di byte che rappresenta il documento da caricare e l'estensione di file del documento.

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)

Parametri

bytes: Byte[]

Matrice di byte che rappresenta il documento da caricare.

fileType: String

Estensione del nome file del documento archiviata nel bytes parametro , preceduta da un punto (.) ad esempio ".xlsx" o ".docx".

Eccezioni

ArgumentNullException

Il bytes parametro è null o vuoto.-oppure-Il fileType parametro è null o vuoto o è costituito interamente da spazi vuoti.

UnknownCustomizationFileException

Il fileType parametro specifica un'estensione di file non supportata dal runtime di Visual Studio Tools per Office.

DocumentCustomizedWithPreviousRuntimeException

Esempio

Nell'esempio di codice seguente viene utilizzato il [costruttore ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.%23ctor%28System.Byte%5B%5D%2CSystem) Costruttore String%29> per creare un nuovo [costruttore ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument> da una matrice di byte contenente una cartella di lavoro di Excel con l'estensione di file .xlsx. Nell'esempio viene quindi utilizzato il [Costruttore ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> ) per visualizzare il numero di byte nel documento.

L'esempio presenta i requisiti seguenti:

Un progetto di applicazione console o un altro progetto non Office.
Riferimenti agli assembly seguenti:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se il progetto è destinato a .NET Framework 4 o .NET Framework 4.5).
  
  oppure
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se il progetto è destinato a .NET Framework 3.5).
Imports (per Visual Basic) o using (per C#) istruzioni per [Costruttore ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications?displayProperty=fullName> e [Costruttore ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.Runtime?displayProperty=fullName> all'inizio del file di codice.

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

Commenti

Utilizzare questo costruttore per accedere ai dati memorizzati nella cache o alle informazioni sul manifesto della distribuzione in un documento già in memoria. Quando si usa questo costruttore, il documento viene aperto con accesso in lettura/scrittura.

Il fileType parametro viene usato solo per determinare il tipo di documento archiviato nella matrice di byte. Il valore di fileType viene mappato a uno dei tipi di file supportati per le personalizzazioni a livello di documento. Non viene effettuato alcun tentativo di aprire il file. Facoltativamente, è possibile passare un nome di file completo (ad esempio, "Workbook1.xlsx"), ma se si esegue questa operazione, viene usata solo l'estensione del nome file. Per altre informazioni sui tipi di file supportati, vedere Architettura delle personalizzazioni di Document-Level.

Per accedere alla matrice di byte per il documento dopo aver chiamato questo costruttore, utilizzare la proprietà [ServerDocument Constructor (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> .

Si applica a

ServerDocument(Stream, String)

Inizializza una nuova istanza della classe ServerDocument utilizzando un flusso che rappresenta il documento da caricare e l'estensione di file del documento.

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)

Parametri

stream: Stream

Flusso che rappresenta il documento da caricare.

fileType: String

Estensione del nome file del documento archiviata nel bytes parametro , preceduta da un punto (.) ad esempio ".xlsx" o ".docx".

Eccezioni

ArgumentNullException

Il stream parametro è null o vuoto.-oppure-Il fileType parametro è null o vuoto o è costituito interamente da spazi vuoti.

ArgumentException

Il parametro stream ha lunghezza zero oppure la posizione corrente è alla fine del flusso.

UnknownCustomizationFileException

Il fileType parametro specifica un'estensione di file non supportata dal runtime di Visual Studio Tools per Office.

DocumentCustomizedWithPreviousRuntimeException

Esempio

Nell'esempio di codice seguente viene utilizzato il ServerDocument(Stream, String) costruttore per creare un nuovo ServerDocument oggetto contenente FileStream una cartella di lavoro di Excel con l'estensione .xlsx nome file. Il codice visualizza quindi l'URL del manifesto della distribuzione per la personalizzazione associata al documento.

L'esempio presenta i requisiti seguenti:

Un progetto di applicazione console o un altro progetto non Office.
Riferimenti agli assembly seguenti:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se il progetto è destinato a .NET Framework 4 o .NET Framework 4.5).
  
  oppure
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se il progetto è destinato a .NET Framework 3.5).
Imports (per Visual Basic) o using (per C#) istruzioni per Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime spazi dei nomi all'inizio del file di codice.

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

Commenti

Per accedere alla matrice di byte per il documento dopo aver chiamato questo costruttore, utilizzare la Document proprietà .

Si applica a

ServerDocument(String, FileAccess)

Inizializza una nuova istanza della classe ServerDocument utilizzando il percorso completo del documento da caricare e un valore indicante l'accesso al file per il documento.

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)

Parametri

documentPath: String

Percorso completo del documento da caricare.

access: FileAccess

Valore che indica l'accesso al file per il documento.

Eccezioni

ArgumentNullException

Il parametro documentPath è null, vuoto, oppure composto unicamente da spazi vuoti.

ArgumentException

Il valore di access è System.IO.FileAccess.Write.

FileNotFoundException

Il file specificato da documentPath non esiste.

DocumentNotCustomizedException

Il file specificato dal documentPath parametro non ha una personalizzazione e il valore di access è System.IO.FileAccess.Read.

DocumentCustomizedWithPreviousRuntimeException

UnknownCustomizationFileException

Il file specificato da documentPath ha un'estensione di file non supportata dal runtime di Visual Studio Tools per Office.

Esempio

Nell'esempio di codice seguente viene utilizzato il ServerDocument(String, FileAccess) costruttore per creare un nuovo ServerDocument oggetto che carica un documento specificato con accesso di sola lettura. Il codice visualizza quindi l'URL del manifesto della distribuzione per la personalizzazione associata al documento.

L'esempio presenta i requisiti seguenti:

Un progetto di applicazione console o un altro progetto non Office.
Riferimenti agli assembly seguenti:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se il progetto è destinato a .NET Framework 4 o .NET Framework 4.5).
  
  oppure
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se il progetto è destinato a .NET Framework 3.5).
Imports (per Visual Basic) o using (per C#) istruzioni per Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime spazi dei nomi all'inizio del file di codice.

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

Commenti

Utilizzare questo costruttore per accedere alle informazioni del manifesto della distribuzione o dei dati memorizzati nella cache in un documento su disco se si desidera aprire il documento con accesso di sola lettura o di sola scrittura. Per impostazione predefinita, gli altri ServerDocument costruttori aprono il documento con accesso in lettura/scrittura.

Si applica a

Condividi tramite

ServerDocument Costruttori

Definizione

Overload

ServerDocument(String)

Parametri

Eccezioni

Esempio

Commenti

Si applica a

ServerDocument(Byte[], String)

Parametri

Eccezioni

Esempio

Commenti

Si applica a

ServerDocument(Stream, String)

Parametri

Eccezioni

Esempio

Commenti

Si applica a

ServerDocument(String, FileAccess)

Parametri

Eccezioni

Esempio

Commenti

Si applica a

Risorse aggiuntive