Gerenciando documentos em um servidor usando a classe do ServerDocument

Se aplica a

As informações contidas neste tópico se aplicam apenas às especificado Ferramentas do Visual Studio para o Office projetos e as versões do Microsoft Office.

Tipo de Projeto

  • Projetos de nível de documento

Versão do Microsoft Office

  • Microsoft Office Sistema de 2007

  • Microsoft Office 2003

For more information, see Recursos disponíveis pelo aplicativo e o tipo de projeto.

Você pode usar a classe ServerDocument para gerenciar vários aspectos da personalizações em nível de documento, mesmo se o Microsoft Office Word e o Microsoft Office Excel não estiverem instalados.Você pode executar as seguintes tarefas:

  • Acessar e modificar dados no cache de dados de um documento ou pasta de trabalho.Para obter mais informações, consulte trabalhando com a dados em cache em que o documento.

  • Gerenciar a personalização de Ferramentas do Visual Studio para o Office para um documento.Para obter mais informações, consulte Gerenciando a personalização de documento .

Noções básicas sobre a classe do ServerDocument

Há duas versões diferentes da classe ServerDocument , uma para cada versão do Tempo de execução Ferramentas do Visual Studio para o Office. Use um que corresponde à versão da solução do Microsoft Office:

Embora as duas versões da classe ServerDocument Compartilhar muito a mesma funcionalidade, existem diferenças em namespaces, conjuntos e membros.Para obter mais informações, consulte Noções básicas sobre ServerDocument diferenças.

A classe ServerDocument foi criada para funcionar em computadores que não possuem o Microsoft Office instalado.Portanto, você normalmente usa essa classe nos projetos que não integram com o Microsoft Office, como projetos de console ou projetos Windows Forms, em vez de projetos de Ferramentas do Visual Studio para o Office.

Para obter mais informações sobre as diferentes versões do Tempo de execução Ferramentas do Visual Studio para o Office , consulte O Visual Studio Tools for Visão geral de tempo de execução do Office.

Trabalhando com dados em cache no documento

Ambos duAmbos versões da clAmbosse ServerDocument fornecem os membros que você pode usar para trabalhar com o cache de dados em documentos personalizados.Para obter mais informações sobre dados armazenados em cache, consulte Cache de dados e Acessando dados em documentos no servidor.

A tabela a seguir lista os membros que você pode usar para trabalhar com dados armazenados em cache.

Tarefa

Projetos do Excel 2007 e o Word 2007

Projetos do Excel 2003 e o Word 2003

Para determinar se o um documento possui um cache de dados Ferramentas do Visual Studio para o Office.

O método IsCacheEnabled in the Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime).

O método IsCacheEnabled in the O Visual Studio 2005 Tools for Office Second Edition runtime.

Para acessar os dados armazenados em cache em um documento.

For more information, see Acessando dados em documentos no servidor.

A propriedade CachedData in the Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime).

A propriedade CachedData in the O Visual Studio 2005 Tools for Office Second Edition runtime.

Gerenciando a personalização de documento

Você pode usar membros da classe ServerDocument para gerenciar a personalização de Ferramentas do Visual Studio para o Office para um documento.Por exemplo, você programaticamente pode remover a personalização de um documento para que o documento não fizer parte de uma personalização Ferramentas do Visual Studio para o Office.

A tabela a seguir lista os membros que você pode usar para gerenciar o assembly de personalização.

Tarefa

Projetos do Excel 2007 e o Word 2007

Projetos do Excel 2003 e o Word 2003

Para determinar se o um documento possui uma personalização Ferramentas do Visual Studio para o Office.

O método GetCustomizationVersion in the Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime).

O método IsCustomized in the O Visual Studio 2005 Tools for Office Second Edition runtime.

Para anexar programaticamente uma personalização a um documento em tempo de execução.

Para obter mais informações, consulte:

Um dos métodos AddCustomization a Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime).

Um dos métodos AddCustomization a O Visual Studio 2005 Tools for Office Second Edition runtime.

Para remover programaticamente uma personalização de um documento em tempo de execução.

Para obter mais informações, consulte:

O método RemoveCustomization in the Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime).

O método RemoveCustomization in the O Visual Studio 2005 Tools for Office Second Edition runtime.

Para obter a URL do manifesto da implantação associado com o documento.

A propriedade DeploymentManifestUrl in the Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime).

O O Visual Studio 2005 Tools for Office Second Edition runtime não Incluir essa propriedade, porque a implantação do manifesto é opcional com soluções de nível de documento para o Excel 2003 e Word 2003; em vez disso, essas soluções sempre tem um manifesto de aplicativo incorporado.

Para acessar o manifesto do aplicativo que está incorporado no documento.

O Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime) não Incluir essa propriedade, porque soluções de nível de documento para o Excel 2007 e o Word 2007 não tem um manifesto de aplicativo incorporado.

A propriedade AppManifest in the O Visual Studio 2005 Tools for Office Second Edition runtime.

Noções básicas sobre diferenças ServerDocument

As duas versões da classe ServerDocument e as classes relacionadas que fornecem o modelo de objeto para dados armazenados em cache (por exemplo, CachedDataHostItem e CachedDataItem) são definidas no diferentes assemblies e namespaces.Além disso, alguns membros e sobrecargas do método são fornecidas no apenas uma versão da classe.Você deve estar ciente dessas diferenças nas seguintes situações:

  • Deseja migrar o código que usa a classe ServerDocument in the O Visual Studio 2005 Tools for Office Second Edition runtime para que ele funcione com soluções do Excel 2007 e o Word 2007.

  • Você deseja usar a clAmbosse ServerDocument no código que funciona com personalizações em nível de documento para o Microsoft Office 2003 e o Microsoft Office Sistema de 2007.

Para obter um exemplo que demonstra como usar Ambos duAmbos versões da clAmbosse ServerDocument no mesmo código, consulte Como: Gravar código que usa duAmbos versões da clAmbosse ServerDocument.

Namespace e diferenças de assembly

A tabela a seguir lista as diferenças Namespace e o assembly para as duas versões da classe ServerDocument e as classes que fornecem o modelo de objeto para dados armazenados em cache.

Versão de tempo de execução

Namespace

Assembly

Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime)

Microsoft.VisualStudio.Tools.Applications

Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll

O Visual Studio 2005 Tools for Office Second Edition runtime

Microsoft.VisualStudio.Tools.Applications.Runtime

Microsoft.VisualStudio.Tools.Applications.Tempo de execução.dll

Diferenças de membro

Os seguintes membros são fornecidos somente na classe ServerDocument a Microsoft Visual Studio Tools para o Microsoft Office system (versão 3.0 Runtime):

Os seguintes membros são fornecidos somente na classe ServerDocument a O Visual Studio 2005 Tools for Office Second Edition runtime:

Consulte também

Tarefas

Como: Gravar código que usa duAmbos versões da clAmbosse ServerDocument

Como: Anexar as extensões de código gerenciado a documentos (Sistema de 2007)

Como: Anexar as extensões de código gerenciado a documentos (Sistema de 2003)

Como: Remover extensões de código gerenciado de documentos (Sistema de 2007)

Como: Remover extensões de código gerenciado de documentos (Sistema de 2003)

Conceitos

O Visual Studio Tools for Visão geral de tempo de execução do Office

Cache de dados

Referência

Microsoft.VisualStudio.Tools.Applications.ServerDocument

Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument