Construtor ServerDocument (String, FileAccess)

Artigo
05/21/2013

Inicializa uma nova instância da classe de ServerDocument que usa o caminho completo do documento sejam carregados e um valor que indica o acesso a arquivos para o documento.

Namespace: Microsoft.VisualStudio.Tools.Applications
Assembly: Microsoft.VisualStudio.Tools.Applications.ServerDocument (em Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Sintaxe

'Declaração
Public Sub New ( _
    documentPath As String, _
    access As FileAccess _
)

public ServerDocument(
    string documentPath,
    FileAccess access
)

Parâmetros

documentPath
Tipo: System.String
O caminho completo do documento a ser carregado.

access
Tipo: System.IO.FileAccess
Um valor que indica o acesso a arquivos para o documento.

Exceções

Exceção	Condição
ArgumentNullException	O parâmetro de documentPath é nulluma referência nula (Nothing no Visual Basic) 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 parâmetro de documentPath não tem uma personalização, e o valor de access é System.IO.FileAccess.Read.
DocumentCustomizedWithPreviousRuntimeException	O arquivo especificado por documentPath tem uma personalização que não é criada no 2010 Visual Studio Tools for Office Runtime ou Visual Studio para o Microsoft Office system (tempo de execução de versão 3,0).
UnknownCustomizationFileException	O arquivo especificado por documentPath possui uma extensão de nome de arquivo que não é suportada por Visual Studio Tools for Office Runtime.

Comentários

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

Exemplos

O exemplo de código usa o construtor de ServerDocument(String, FileAccess) para criar uma nova ServerDocument ao carregar um documento especificado com acesso somente leitura.O código então exibe a URL do manifesto de implantação para personalização que é anexada ao documento.

Este exemplo requer:

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

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

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

ServerDocument Classe

Sobrecargas ServerDocument

Namespace Microsoft.VisualStudio.Tools.Applications

Compartilhar via