使用 ServerDocument 类管理服务器上的文档

  • 项目

即使未安装 Microsoft Office Word 和 Microsoft Office Excel，您也可以使用 Visual Studio Tools for Office Runtime中的 ServerDocument 类管理文档级自定义项的多个方面。 您可以执行以下任务：

  • 访问和修改文档或工作簿的数据缓存中的数据。 有关更多信息，请参见处理文档中的缓存数据。

  • 管理与文档相关联的自定义项程序集。 有关更多信息，请参见管理文档自定义项。

**适用于：**本主题中的信息适用于以下应用程序的文档级项目：Excel 2007 和 Excel 2010；Word 2007 和 Word 2010。有关更多信息，请参见按 Office 应用程序和项目类型提供的功能。

了解 ServerDocument 类

ServerDocument 类设计为在未安装 Office 的计算机上使用。 因此，您通常在未与 Office 集成的应用程序（如控制台项目或 Windows 窗体项目）中使用此类，而不会在 Office 项目中使用。

Visual Studio 2010 Tools for Office Runtime 中的 ServerDocument 类有两个不同的版本。您应该使用的版本取决于要在其中使用该类的应用程序的目标 .NET Framework：

  • 对于面向 .NET Framework 4 的应用程序，使用 Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll 程序集中的 Microsoft.VisualStudio.Tools.Applications.ServerDocument 类。 

  • 对于面向 .NET Framework 3.5 的应用程序，使用 Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll 程序集中的 Microsoft.VisualStudio.Tools.Applications.ServerDocument 类。

两个版本的 ServerDocument 类都可用于对使用 Visual Studio 2010 创建的文档级自定义项进行操作，或者对使用 Visual Studio 2008 创建的 Excel 2007 和 Word 2007 文档级自定义项进行操作。

有关 Visual Studio 2010 Tools for Office Runtime和 Office 的 .NET Framework 扩展的更多信息，请参见 Visual Studio Tools for Office Runtime 概述。

提示

如果有旧版应用程序在 Visual Studio Tools for Office system（3.0 版运行时） 中使用 ServerDocument 类，必须将 Visual Studio Tools for Office system（3.0 版运行时） 安装在运行该应用程序的计算机上。 Visual Studio 2010 Tools for Office Runtime 无法运行这些应用程序。

处理文档中的缓存数据

ServerDocument 类提供可用于处理自定义文档中的数据缓存的成员。 有关缓存数据的更多信息，请参见缓存数据和访问服务器上的文档数据。

下表列出了可用于处理缓存数据的成员。

任务

使用的成员

确定文档中是否具有数据缓存。

IsCacheEnabled 方法。

访问文档中的缓存数据。

有关更多信息，请参见访问服务器上的文档数据。

CachedData 属性。

管理文档自定义项

您可以使用 ServerDocument 类的成员管理与文档相关联的自定义项程序集。 例如，您可以通过编程方式移除文档中的自定义项，使文档不再是自定义项的一部分。

下表列出了可用于管理自定义项程序集的成员。

任务

使用的成员

确定文档是否是文档级自定义项的一部分。

GetCustomizationVersion 方法。

在运行时以编程方式将自定义项附加到文档。

有关更多信息，请参见如何：将托管代码扩展附加到文档

AddCustomization 方法之一。

在运行时以编程方式从文档中移除一个自定义项。

有关更多信息，请参见如何：移除文档中的托管代码扩展。

RemoveCustomization 方法。

获取与文档关联的部署清单的 URL。

DeploymentManifestUrl 属性。

请参见

任务

如何：将托管代码扩展附加到文档

如何：移除文档中的托管代码扩展

参考

Microsoft.VisualStudio.Tools.Applications.ServerDocument

概念

Visual Studio Tools for Office Runtime 概述

缓存数据