Управление документами на сервере с помощью класса ServerDocument
Обновлен: Ноябрь 2007
Применение |
|---|
Сведения в данном разделе относятся только к указанным проектам Visual Studio Tools for Office и версиям приложений Microsoft Office. Тип проекта
Версия Microsoft Office
Дополнительные сведения см. в разделе Доступность функций по типам приложений и проектов. |
Для управления некоторыми аспектами настроек уровня документа можно использовать класс ServerDocument, даже на сервере не установлены Microsoft Office Word и Microsoft Office Excel. На этом занятии можно выполнить следующие задачи.
Получение доступа к данным и изменение данных в кэше данных документа или рабочей книги. Дополнительные сведения см. в разделе Работа с кэшированными данными в документе.
Управление настройкой Visual Studio Tools for Office для документа. Дополнительные сведения см. в разделе Управление настройкой документа.
Основные сведения о классе ServerDocument
Есть две различные версии класса ServerDocument — по одной для каждой версии среды выполнения Visual Studio Tools for Office. Следует использовать версию, соответствующую версии решения Microsoft Office.
Следует использовать класс Microsoft.VisualStudio.Tools.Applications.ServerDocument с настройками для Excel 2007 и Word 2007. Этот класс предоставляет среда Visual Studio Tools for Office, версия 3.0 (cреда выполнения).
Следует использовать класс 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 Forms, но не в проектах Visual Studio Tools for Office.
Дополнительные сведения о различных версиях среды выполнения Visual Studio Tools for Office см. в разделе Общие сведения об инструментах Visual Studio для среды выполнения Office.
Работа с кэшированными данными в документе
Обе версии класса ServerDocument предоставляют члены, которые можно использовать для работы с кэшем данных в настроенных документах. Дополнительные сведения о кэшированных данных см. в разделах Кэширование данных и Доступ к данным в документах на сервере.
В следующей таблице перечислены методы, используемые для работы с кэшированными данными.
Задача |
Проекты Excel 2007 и Word 2007 |
Проекты Excel 2003 и Word 2003 |
|---|---|---|
Определение того, есть ли в документе кэш данных Visual Studio Tools for Office. |
Метод IsCacheEnabled в среде Visual Studio Tools for Office, версия 3.0 (cреда выполнения). |
Метод IsCacheEnabled в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения). |
Получение доступа к кэшированным данным в документе. Дополнительные сведения см. в разделе Доступ к данным в документах на сервере. |
Свойство CachedData в среде Visual Studio Tools for Office, версия 3.0 (cреда выполнения). |
Свойство CachedData в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения). |
Управление настройкой документа
Для управления настройкой документа среды выполнения Visual Studio Tools for Office можно использовать метод ServerDocument. Например, можно программными средствами удалить настройку из документа, таким образом он перестанет быть частью настройки Visual Studio Tools for Office.
В следующей таблице перечислены методы, используемые для управления сборкой настройки.
Задача |
Проекты Excel 2007 и Word 2007 |
Проекты Excel 2003 и Word 2003 |
|---|---|---|
Определение того, есть ли в документе настройка Visual Studio Tools for Office. |
Метод GetCustomizationVersion в среде Visual Studio Tools for Office, версия 3.0 (cреда выполнения). |
Метод IsCustomized в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения). |
Прикрепление настройки к документу программным способом во время выполнения. Дополнительные сведения см. в следующих разделах: |
Один из методов класса AddCustomization в Visual Studio Tools for Office, версия 3.0 (cреда выполнения). |
Один из методов класса AddCustomization в Visual Studio 2005 Tools for Office Second Edition (среда выполнения). |
Удаление настройки из документа программным способом во время выполнения. Дополнительные сведения см. в следующих разделах: |
Метод RemoveCustomization в среде Visual Studio Tools for Office, версия 3.0 (cреда выполнения). |
Метод RemoveCustomization в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения). |
Получение URL-адреса манифеста развертывания, связанного с документом, и его изменение. |
Свойство DeploymentManifestUrl в среде Visual Studio Tools for Office, версия 3.0 (cреда выполнения). |
В среду выполнения Visual Studio 2005 Tools for Office Second Edition (среда выполнения) не включено это свойство, так как манифест развертывания является необязательным для решений уровня документа для Excel 2003 и Word 2003. В этих решениях всегда есть встроенный манифест приложения. |
Получение доступа к встроенному в документ манифесту приложения. |
Это свойство не включено в среду выполнения Visual Studio Tools for Office, версия 3.0 (cреда выполнения), поскольку решения уровня документа для Excel 2007 и Word 2007 не содержат встроенного манифеста приложения. |
Свойство AppManifest в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения). |
Основные сведения о различиях классов ServerDocument
Две версии класса ServerDocument и связанные с ним классы, предоставляющие объектную модель для кэшированных данных (например, CachedDataHostItem и CachedDataItem), определены в разных сборках и пространствах имен. Кроме этого, перегрузки некоторых членов и методов есть только в одной версии класса. Необходимо знать о следующих различиях для подобных случаев:
Требуется выполнить миграцию кода, в котором используется класс ServerDocument в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения), из-за чего он работает с решениями Excel 2007 и Word 2007.
Необходимо использовать класса ServerDocument в коде, работающем с настройками уровня документа как для Microsoft Office 2003, так и для Microsoft Office 2007.
Пример кода, демонстрирующий использование обеих версий класса ServerDocument в одном файле кода, см. в разделе Практическое руководство. Написание кода, в котором используются обе версии класса ServerDocument.
Различия пространств имен и сборок
В следующей таблице перечислены различия пространств имен и сборок для двух версий класса ServerDocument и классов, предоставляющих объектную модель для кэшированных данных.
Версия среды выполнения |
Пространство имен |
Сборка |
|---|---|---|
Visual Studio Tools for Office, версия 3.0 (cреда выполнения) |
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll |
|
Visual Studio 2005 Tools for Office Second Edition (среда выполнения) |
Microsoft.VisualStudio.Tools.Applications.Runtime.dll |
Различия членов
Следующие члены присутствуют только в классе ServerDocument в среде Visual Studio Tools for Office, версия 3.0 (cреда выполнения):
Следующие члены присутствуют только в классе ServerDocument в среде Visual Studio 2005 Tools for Office Second Edition (среда выполнения):
См. также
Задачи
Практическое руководство. Написание кода, в котором используются обе версии класса ServerDocument
Практическое руководство. Вложение расширений управляемого кода в документы (система 2007)
Практическое руководство. Вложение расширений управляемого кода в документы (система 2003)
Практическое руководство. Удаление расширений управляемого кода из документов (система 2007)
Практическое руководство. Удаление расширений управляемого кода из документов (система 2003)
Основные понятия
Общие сведения об инструментах Visual Studio для среды выполнения Office
Ссылки
Microsoft.VisualStudio.Tools.Applications.ServerDocument
Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument