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

项目
08/18/2008

更新：2007 年 11 月

适用对象
本主题中的信息仅适用于指定的 Visual Studio Tools for Office 项目和 Microsoft Office 版本。项目类型文档级项目 Microsoft Office 版本 2007 Microsoft Office system Microsoft Office 2003 有关更多信息，请参见按应用程序和项目类型提供的功能。

本主题中的信息仅适用于指定的 Visual Studio Tools for Office 项目和 Microsoft Office 版本。

项目类型

文档级项目

Microsoft Office 版本

2007 Microsoft Office system
Microsoft Office 2003

有关更多信息，请参见按应用程序和项目类型提供的功能。

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

访问和修改文档或工作簿的数据缓存中的数据。有关更多信息，请参见处理文档中的缓存数据。
管理文档的 Visual Studio Tools for Office 自定义项。有关更多信息，请参见管理文档自定义项。

了解 ServerDocument 类

ServerDocument 类有两个不同的版本，分别与 Visual Studio Tools for Office 运行时的每个版本相对应。请使用与 Microsoft Office 的解决方案版本相对应的类版本：

将 Microsoft.VisualStudio.Tools.Applications.ServerDocument 类用于 Excel 2007 和 Word 2007 的自定义项。该类由 Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）提供。
将 Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument 类用于 Excel 2003 和 Word 2003 的自定义项。该类由 Visual Studio 2005 Tools for Office Second Edition 运行时提供。

虽然两个版本的 ServerDocument 类具有许多相同的功能，但是在命名空间、程序集和成员方面仍有差异。有关更多信息，请参见了解 ServerDocument 差异。

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

有关不同版本的 Visual Studio Tools for Office 运行时的更多信息，请参见 Visual Studio Tools for Office 运行库概述。

处理文档中的缓存数据

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

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

任务	Excel 2007 和 Word 2007 项目	Excel 2003 和 Word 2003 项目
确定文档中是否具有 Visual Studio Tools for Office 数据缓存。	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 IsCacheEnabled 方法。	Visual Studio 2005 Tools for Office Second Edition 运行时中的 IsCacheEnabled 方法。
访问文档中的缓存数据。有关更多信息，请参见访问服务器上的文档数据。	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 CachedData 属性。	Visual Studio 2005 Tools for Office Second Edition 运行时中的 CachedData 属性。

确定文档中是否具有 Visual Studio Tools for Office 数据缓存。

Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 IsCacheEnabled 方法。

Visual Studio 2005 Tools for Office Second Edition 运行时中的 IsCacheEnabled 方法。

访问文档中的缓存数据。

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

Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 CachedData 属性。

Visual Studio 2005 Tools for Office Second Edition 运行时中的 CachedData 属性。

管理文档自定义项

您可以使用 ServerDocument 类的成员管理文档的 Visual Studio Tools for Office 自定义项。例如，您可以通过编程方式移除文档中的自定义项，使文档不再是 Visual Studio Tools for Office 自定义项的一部分。

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

任务	Excel 2007 和 Word 2007 项目	Excel 2003 和 Word 2003 项目
确定文档中是否具有 Visual Studio Tools for Office 自定义项。	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 GetCustomizationVersion 方法。	Visual Studio 2005 Tools for Office Second Edition 运行时中的 IsCustomized 方法。
在运行时以编程方式将自定义项附加到文档。有关更多信息，请参见：如何：将托管代码扩展附加到文档 (2007 System) 如何：将托管代码扩展附加到文档 (2003 System)	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 AddCustomization 方法之一。	Visual Studio 2005 Tools for Office Second Edition 运行时中的 AddCustomization 方法之一。
在运行时以编程方式从文档中移除一个自定义项。有关更多信息，请参见：如何：移除文档中的托管代码扩展 (2007 System) 如何：移除文档中的托管代码扩展 (2003 System)	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 RemoveCustomization 方法。	Visual Studio 2005 Tools for Office Second Edition 运行时中的 RemoveCustomization 方法。
获取与文档关联的部署清单的 URL。	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）中的 DeploymentManifestUrl 属性。	Visual Studio 2005 Tools for Office Second Edition 运行时中不包含此属性，因为部署清单是 Excel 2003 和 Word 2003 的文档级解决方案的可选项，这些解决方案始终具有嵌入式应用程序清单。
访问嵌入在文档中的应用程序清单。	Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）不包括此属性，因为 Excel 2007 和 Word 2007 的文档级解决方案没有嵌入式应用程序清单。	Visual Studio 2005 Tools for Office Second Edition 运行时中的 AppManifest 属性。

了解 ServerDocument 差异

两个版本的 ServerDocument 类和为缓存数据提供对象模型的相关类（如 CachedDataHostItem 和 CachedDataItem）是在不同的程序集和命名空间中定义的。此外，一些成员和方法重载只在一个版本的类中提供。您在以下情况下应注意这些差异：

希望迁移使用 Visual Studio 2005 Tools for Office Second Edition 运行时中的 ServerDocument 类的代码，以便它既可用于 Excel 2007 也可用于 Word 2007 解决方案。
希望在代码中使用适用于 Microsoft Office 2003 和 2007 Microsoft Office system 文档级自定义项的 ServerDocument 类。

有关演示如何在相同的代码中使用两种版本的 ServerDocument 类的示例，请参见如何：编写使用两个版本的 ServerDocument 类的代码。

命名空间和程序集差异

下表列出了两个版本的 ServerDocument 类和为缓存数据提供对象模型的类之间在命名空间和程序集方面的差异。

运行时版本	命名空间	程序集
Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）	Microsoft.VisualStudio.Tools.Applications	Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll
Visual Studio 2005 Tools for Office Second Edition 运行时	Microsoft.VisualStudio.Tools.Applications.Runtime	Microsoft.VisualStudio.Tools.Applications.Runtime.dll

成员差异

下面的成员仅在 Microsoft Visual Studio Tools for the Microsoft Office system（3.0 版运行时）的 ServerDocument 类中提供：

下面的成员仅在 Visual Studio 2005 Tools for Office Second Edition 运行时中的 ServerDocument 类中提供：

请参见

通过