ServerDocument Construtores

Referência

Definição

Namespace:: Microsoft.VisualStudio.Tools.Applications

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

ServerDocument(String)	Inicializa uma nova instância da classe ServerDocument usando o caminho completo do documento a ser carregado.
ServerDocument(Byte[], String)	Inicializa uma nova instância da classe ServerDocument usando uma matriz de bytes que representa o documento a ser carregado e a extensão de nome de arquivo do documento.
ServerDocument(Stream, String)	Inicializa uma nova instância da classe ServerDocument usando um fluxo que representa o documento a ser carregado e a extensão de nome de arquivo do documento.
ServerDocument(String, FileAccess)	Inicializa uma nova instância da classe ServerDocument usando o caminho completo do documento a ser carregado e um valor que indica o acesso ao arquivo do documento.

ServerDocument(String)

Inicializa uma nova instância da classe ServerDocument usando o caminho completo do documento a ser carregado.

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)

Parâmetros

documentPath: String

O caminho completo do documento a ser carregado.

Exceções

ArgumentNullException

O parâmetro documentPath é null ou vazio ou consiste inteiramente em caracteres de espaço em branco.

FileNotFoundException

O arquivo especificado por documentPath não existe.

DocumentCustomizedWithPreviousRuntimeException

O arquivo especificado por documentPath tem uma personalização que não é criada com Ferramentas do Visual Studio 2010 for Office Runtime ou Visual Studio Tools for the Microsoft Office system (Runtime versão 3.0).

UnknownCustomizationFileException

O arquivo especificado por documentPath tem uma extensão de nome de arquivo que não é compatível com o runtime do Visual Studio Tools para Office.

Exemplos

O exemplo de código a seguir usa o ServerDocument(String) construtor para criar um novo ServerDocument que carrega um documento especificado. Em seguida, o exemplo exibe a URL do manifesto de implantação para a personalização anexada ao documento.

Este exemplo requer:

Um projeto de aplicativo do console ou qualquer outro projeto que não seja do Office.
Referências para os seguintes assemblies:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se o projeto for direcionado ao .NET Framework 4 ou ao .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (caso o projeto segmente o .NET Framework 3.5).
Instruções Imports (para Visual Basic) ou using (para C#) para namespaces Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime na parte superior do arquivo de código.

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

Comentários

Use esse construtor para acessar os dados armazenados em cache ou as informações de manifesto de implantação em um documento que está em disco. Quando você usa esse construtor, o documento especificado é aberto com acesso de leitura/gravação.

Aplica-se a

ServerDocument(Byte[], String)

Inicializa uma nova instância da classe ServerDocument usando uma matriz de bytes que representa o documento a ser carregado e a extensão de nome de arquivo do 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)

Parâmetros

bytes: Byte[]

Uma matriz de bytes que representa o documento a ser carregado.

fileType: String

A extensão de nome de arquivo do documento armazenado no bytes parâmetro , precedida por um ponto (.) — por exemplo, ".xlsx" ou ".docx".

Exceções

ArgumentNullException

O bytes parâmetro é null ou empty.-or-O fileType parâmetro é ou vazio null ou consiste inteiramente em caracteres de espaço em branco.

UnknownCustomizationFileException

O fileType parâmetro especifica uma extensão de nome de arquivo que não é compatível com o runtime do Visual Studio Tools para Office.

DocumentCustomizedWithPreviousRuntimeException

Exemplos

O exemplo de código a seguir usa o construtor [ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.%23ctor%28System.Byte%5B%5D%2CSystem Construtor .String%29> para criar um novo construtor [ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument> de uma matriz de bytes que contém uma pasta de trabalho do Excel com a extensão de nome de arquivo .xlsx. Em seguida, o exemplo usa a propriedade [Construtor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> para exibir o número de bytes no documento.

Este exemplo requer:

Um projeto de aplicativo do console ou qualquer outro projeto que não seja do Office.
Referências para os seguintes assemblies:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se o projeto for direcionado ao .NET Framework 4 ou ao .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (caso o projeto segmente o .NET Framework 3.5).
Imports (para Visual Basic) ou using (para C#) instruções para [Construtor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications?displayProperty=fullName> e [Construtor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.Runtime?displayProperty=fullName> namespaces na parte superior do arquivo de código.

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

Comentários

Use esse construtor para acessar os dados armazenados em cache ou as informações de manifesto de implantação em um documento que já está na memória. Quando você usa esse construtor, o documento é aberto com acesso de leitura/gravação.

O fileType parâmetro é usado apenas para determinar o tipo de documento armazenado na matriz de bytes. O valor de fileType é mapeado para um dos tipos de arquivo com suporte para personalizações no nível do documento. Não é feita nenhuma tentativa de abrir o arquivo. Opcionalmente, você pode passar um nome de arquivo completo (por exemplo, "Workbook1.xlsx"), mas, se fizer isso, somente a extensão de nome de arquivo será usada. Para obter mais informações sobre os tipos de arquivo com suporte, consulte Arquitetura de personalizações de Document-Level.

Para acessar a matriz de bytes do documento depois de chamar esse construtor, use a propriedade [Construtor ServerDocument (Byte<xref:Microsoft.VisualStudio.Tools.Applications.ServerDocument.Document%2A> .

Aplica-se a

ServerDocument(Stream, String)

Inicializa uma nova instância da classe ServerDocument usando um fluxo que representa o documento a ser carregado e a extensão de nome de arquivo do 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)

Parâmetros

stream: Stream

Um fluxo que representa o documento a ser carregado.

fileType: String

A extensão de nome de arquivo do documento armazenado no bytes parâmetro , precedida por um ponto (.) — por exemplo, ".xlsx" ou ".docx".

Exceções

ArgumentNullException

O stream parâmetro é null ou empty.-or-O fileType parâmetro é ou vazio null ou consiste inteiramente em caracteres de espaço em branco.

ArgumentException

O parâmetro stream tem comprimento zero ou sua posição atual está no final do fluxo.

UnknownCustomizationFileException

O fileType parâmetro especifica uma extensão de nome de arquivo que não é compatível com o runtime do Visual Studio Tools para Office.

DocumentCustomizedWithPreviousRuntimeException

Exemplos

O exemplo de código a seguir usa o ServerDocument(Stream, String) construtor para criar um novo ServerDocument de um que contém uma FileStream pasta de trabalho do Excel com a extensão de nome de arquivo .xlsx. Em seguida, o código exibe a URL do manifesto de implantação para a personalização anexada ao documento.

Este exemplo requer:

Um projeto de aplicativo do console ou qualquer outro projeto que não seja do Office.
Referências para os seguintes assemblies:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se o projeto for direcionado ao .NET Framework 4 ou ao .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (caso o projeto segmente o .NET Framework 3.5).
Instruções Imports (para Visual Basic) ou using (para C#) para namespaces Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime na parte superior do arquivo de código.

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

Comentários

Para acessar a matriz de bytes do documento depois de chamar esse construtor, use a Document propriedade .

Aplica-se a

ServerDocument(String, FileAccess)

Inicializa uma nova instância da classe ServerDocument usando o caminho completo do documento a ser carregado e um valor que indica o acesso ao arquivo do 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)

Parâmetros

documentPath: String

O caminho completo do documento a ser carregado.

access: FileAccess

Um valor que indica o acesso ao arquivo para o documento.

Exceções

ArgumentNullException

O parâmetro documentPath é null ou vazio ou consiste inteiramente em caracteres de espaço em branco.

ArgumentException

O valor de access é System.IO.FileAccess.Write.

FileNotFoundException

O arquivo especificado por documentPath não existe.

DocumentNotCustomizedException

O arquivo especificado pelo documentPath parâmetro não tem uma personalização e o valor de access é System.IO.FileAccess.Read.

DocumentCustomizedWithPreviousRuntimeException

UnknownCustomizationFileException

O arquivo especificado por documentPath tem uma extensão de nome de arquivo que não é compatível com o runtime do Visual Studio Tools para Office.

Exemplos

O exemplo de código a seguir usa o ServerDocument(String, FileAccess) construtor para criar um novo ServerDocument que carrega um documento especificado com acesso somente leitura. Em seguida, o código exibe a URL do manifesto de implantação para a personalização anexada ao documento.

Este exemplo requer:

Um projeto de aplicativo do console ou qualquer outro projeto que não seja do Office.
Referências para os seguintes assemblies:
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se o projeto for direcionado ao .NET Framework 4 ou ao .NET Framework 4.5).
  
  ou
- Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (caso o projeto segmente o .NET Framework 3.5).
Instruções Imports (para Visual Basic) ou using (para C#) para namespaces Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime na parte superior do arquivo de código.

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

Comentários

Use esse construtor para acessar os dados armazenados em cache ou as informações de manifesto de implantação em um documento que está em disco se você quiser abrir o documento com acesso somente leitura ou somente gravação. Por padrão, os outros ServerDocument construtores abrem o documento com acesso de leitura/gravação.

Aplica-se a

Compartilhar via

ServerDocument Construtores

Definição

Sobrecargas

ServerDocument(String)

Parâmetros

Exceções

Exemplos

Comentários

Aplica-se a

ServerDocument(Byte[], String)

Parâmetros

Exceções

Exemplos

Comentários

Aplica-se a

ServerDocument(Stream, String)

Parâmetros

Exceções

Exemplos

Comentários

Aplica-se a

ServerDocument(String, FileAccess)

Parâmetros

Exceções

Exemplos

Comentários

Aplica-se a

Recursos adicionais