Поделиться через

Пошаговое руководство. Вставка данных в книгу на сервере

  • Статья

Обновлен: Ноябрь 2007

Применимость

Сведения в данном разделе относятся только к указанным проектам Visual Studio Tools for Office и версиям приложений Microsoft Office.

Тип проекта

  • Проекты уровня документа

Версия Microsoft Office

  • Excel 2007

  • Excel 2003

Дополнительные сведения см. в разделе Доступность функций по типам приложений и проектов.

В этом пошаговом руководстве описано, как вставить данные в набор данных, кэшированный в рабочей книге Microsoft Office Excel, не запуская Excel, с помощью класса ServerDocument. В этом пошаговом руководстве даны поэтапные инструкции по применению примера кода, описанного в разделе Практическое руководство. Вставка данных в книгу на сервере.

В этом руководстве описываются следующие задачи.

  • Определение набора данных, содержащего данные из базы данных AdventureWorksLT для Microsoft SQL Server 2005.

  • Создание экземпляров набора данных в проекте рабочей книги Excel и проекте консольного приложения.

  • Создание элемента ListObject, привязанного к набору данных в книге.

  • Добавление набора данных рабочей книги в кэш данных.

  • Вставка данных в кэшированный набор данных путем выполнения кода в консольном приложении, не запуская Excel.

Хотя в этом пошаговом руководстве предполагается, что код выполняется на компьютере разработчика, описанный здесь код может использоваться и на сервере, на котором не установлен Excel.

Cc442984.alert_note(ru-ru,VS.90).gifПримечание.

На компьютере могут отображаться имена или расположения некоторых элементов пользовательского интерфейса Visual Studio, отличающиеся от указанных в дальнейших инструкциях. Эти элементы определяются используемой версией Visual Studio и ее параметрами. Дополнительные сведения см. в разделе Параметры Visual Studio.

Обязательные компоненты

Ниже приведены компоненты, необходимые для выполнения данного пошагового руководства.

Создание проекта библиотеки классов, определяющего набор данных

Для использования того же набора данных в проекте книги Excel и в консольном приложении необходимо определить набор данных в отдельной сборке, на которую ссылаются оба проекта. Для этого пошагового руководства определите набор данных в проекте библиотеки классов.

Чтобы создать проект библиотеки классов

  1. Запустите Visual Studio.

  2. В меню Файл выберите команду Создать и щелкните Проект.

  3. В панели Типы проектов разверните узел Visual C# или Visual Basic, а затем щелкните Windows.

  4. В области Шаблоны выберите пункт Библиотека классов.

  5. В поле Имя введите AdventureWorksDataSet.

  6. Нажмите Обзор, перейдите в папку %UserProfile%\Мои документы (для Windows XP и более ранних версий) или %UserProfile%\Документы (для Windows Vista) и нажмите Выбрать папку.

  7. В диалоговом окне Новый проект снимите флажок Создать папку для решения.

  8. Нажмите кнопку ОК.

    Visual Studio добавит проект AdventureWorksDataSet в обозреватель решений и откроет файл кода Class1.cs или Class1.vb.

  9. В обозревателе решений щелкните правой кнопкой мыши Class1.cs или Class1.vb и выберите команду Удалить. В данном пошаговом руководстве этот файл не нужен.

Определение набора данных в проекте библиотеки классов

Определите набор данных, содержащий данные из базы данных AdventureWorksLT для SQL Server 2005. Позднее в этом пошаговом руководстве создается ссылка на этот набор данных в проекте книги Excel и проекте консольного приложения.

Набор данных — типизированный набор данных, представляющий данные в таблице Product базы данных AdventureWorksLT. Дополнительные сведения о типизированных наборах данных см. в разделе Общие сведения о наборах данных в Visual Studio.

Определение типизированного набора данных в проекте библиотеки классов

  1. В обозревателе решений щелкните проект AdventureWorksDataSet.

  2. В меню Данные выберите команду Добавить новый источник данных.

    Появится мастер настройки источника данных.

  3. Щелкните База данных и нажмите кнопку Далее.

  4. Если подключение к базе данных AdventureWorksLT существует, выберите его и нажмите кнопку Далее.

    В противном случае нажмите кнопку Новое подключение и с помощью диалогового окна Добавить подключение создайте новое подключение. Дополнительные сведения см. в разделе Практическое руководство. Создание подключений к базам данных SQL Server.

  5. На странице Save the Connection String to the Application Configuration File, нажмите кнопку Next.

  6. На странице Выбор объектов базы данных разверните Таблицы и выберите Product (SalesLT).

  7. Нажмите кнопку Готово.

    Файл AdventureWorksLTDataSet.xsd добавлен к проекту AdventureWorksDataSet. Этот файл определяет следующие элементы:

    • Типизированный набор данных с именем AdventureWorksLTDataSet. Этот набор данных представляет содержимое таблицы Product в базе данных AdventureWorksLT.

    • Адаптер таблиц TableAdapter с именем ProductTableAdapter. Этот адаптер TableAdapter может использоваться для чтения и записи данных в AdventureWorksLTDataSet. Дополнительные сведения см. в разделе Общие сведения об адаптере таблиц.

    Далее в пошаговом руководстве используются оба эти объекта.

  8. В обозревателе решений щелкните правой кнопкой мыши AdventureWorksDataSet, а затем щелкните Построить.

    Убедитесь, что построение проекта выполнено без ошибок.

Создание проекта книги Excel

Создайте проект рабочей книги Excel для интерфейса данных. Далее создается объект ListObject, отображающий данные, и добавляется экземпляр набора данных в кэш рабочей книги.

Создание проекта книги Excel

  1. В обозревателе решений щелкните правой кнопкой мыши решение AdventureWorksDataSet, выберите Добавить и затем щелкните Новый проект.

  2. В панели Типы проектов разверните узел Visual C# или Visual Basic, а затем разверните узел Office.

  3. Выберите папку 2007, если используется Excel 2007 на компьютере разработчика, или папку 2003, если используется Excel 2003.

  4. Затем в панели Шаблоны выберите Книга Excel.

  5. В поле Имя введите AdventureWorksReport. Не изменяйте расположение.

  6. Нажмите кнопку ОК.

    Откроется вкладка Мастер проектов Visual Studio Tools for Office.

  7. Убедитесь, что выбрано Создать новый документ, и нажмите кнопку OK.

    Visual Studio откроет созданную книгу AdventureWorksReport в конструкторе и добавит проект AdventureWorksReport в обозреватель решений.

Добавление базы данных к источнику данных в проекте книги Excel

Перед тем, как можно будет отобразить набор данных в книге Excel, необходимо добавить набор данных к источникам данных проекта книги Excel.

Добавление набора данных к источникам данных в проекте книги Excel

  1. В обозревателе решений дважды щелкните Sheet1.cs или Sheet1.vb в проекте AdventureWorksReport.

    Книга откроется в конструкторе.

  2. В меню Данные выберите команду Добавить новый источник данных.

    Появится мастер настройки источника данных.

  3. Выберите Объект и нажмите кнопку Далее.

  4. На странице Выбор объекта для привязки нажмите кнопку Добавить ссылку.

  5. На вкладке Проекты выберите AdventureWorksDataSet, после чего нажмите кнопку ОК.

  6. В пространстве имен AdventureWorksDataSet сборки AdventureWorksDataSet выберите AdventureWorksLTDataSet и нажмите кнопку Готово.

    Откроется окно Источники данных и AdventureWorksLTDataSet будет добавлен к списку источников данных.

Создание элемента ListObject, привязанного к экземпляру базы данных

Для отображения набора данных в книге создайте ListObject с привязкой к экземпляру набора данных. Дополнительные сведения о привязке элементов управления к данным см. в разделе Привязка данных к элементам управления.

Создание элемента ListObject, привязанного к экземпляру базы данных

  1. В окне Источники данных разверните узел AdventureWorksLTDataSet источника данных AdventureWorksDataSet.

  2. Выберите узел Product, щелкните направленную вниз стрелку и выберите в раскрывающемся списке ListObject.

    Если раскрывающийся список не появляется, убедитесь, что рабочая книга открыта в конструкторе.

  3. Перетащите таблицу Product на ячейку A1.

    Элемент управления ListObject с именем productListObject создается на листе с началом в ячейке A1. Одновременно в проект добавляется объект набора данных adventureWorksLTDataSet и BindingSource с именем productBindingSource. ListObject привязан к BindingSource, который, в свою очередь, связан с экземпляром набора данных.

Добавление набора данных к кэшу данных

Чтобы обеспечить коду вне книги Excel возможность получить доступ к набору данных в книге, необходимо добавить набор данных в кэш. Дополнительные сведения о кэше данных см. в разделах Модель данных в настройках уровня документа и Кэширование данных.

Добавление набора данных в кэш

  1. В конструкторе выберите adventureWorksLTDataSet.

  2. В окне Свойства измените значение свойства Modifiers на Public.

  3. Измените значение свойства CacheInDocument на True.

Контрольная точка

Постройте и выполните проект книги Excel, чтобы убедиться, что он компилируется и выполняется без ошибок.

Построение и запуск проекта

  1. В обозревателе решений щелкните правой кнопкой мыши проект AdventureWorksReport, выберите Отладка и нажмите кнопку Запустить новый экземпляр.

    Выполняется построение проекта, а рабочая книга открывается в Excel. Элемент ListObject на листе Sheet1 пуст, так как объект adventureWorksLTDataSet в кэше еще не содержит данных. В следующем разделе консольное приложение используется для заполнения объекта adventureWorksLTDataSet данными.

  2. Закройте Excel. Не сохраняйте изменения.

Создание проекта консольного приложения

Создайте проект консольного приложения для вставки данных в кэшированный набор данных в книге.

Создание проекта консольного приложения

  1. В обозревателе решений щелкните правой кнопкой мыши решение AdventureWorksDataSet, выберите Добавить и затем щелкните Новый проект.

  2. В панели Типы проектов разверните узел Visual C# или Visual Basic, а затем щелкните Windows.

  3. Выберите область Консольное приложение в области Шаблоны.

  4. В поле Имя введите DataWriter. Не изменяйте расположение.

  5. Нажмите кнопку ОК.

    Visual Studio добавит проект DataWriter в обозреватель решений и откроет файл кода Program.cs или Module1.vb.

Добавление данных в кэшированный набор данных с помощью консольного приложения

Класс ServerDocument в консольном приложении следует использовать для заполнения кэшированного набора данных в книге.

Добавление данных в кэшированный набор данных

  1. В обозревателе решений щелкните правой кнопкой мыши проект DataWriter и выберите команду Добавить ссылку.

  2. На вкладке .NET выберите одну из следующих сборок.

    • Если на компьютере разработчика используется Excel 2007, выберите Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.

    • Если используется Excel 2003, выберите Microsoft.VisualStudio.Tools.Applications.Runtime.

    Эти сборки определяют различные версии класса ServerDocument, используемого проектами для версии 2007 системы Microsoft Office и Microsoft Office 2003. Дополнительные сведения см. в разделе Управление документами на сервере с помощью класса ServerDocument.

  3. Нажмите кнопку ОК.

  4. В обозревателе решений щелкните правой кнопкой мыши на проекте DataWriter и выберите команду Добавить ссылку.

  5. На вкладке Проекты выберите AdventureWorksDataSet, после чего нажмите кнопку ОК.

  6. Откройте файл Program.cs или Module1.vb в редакторе кода.

  7. Добавьте операторы using (для Visual C#) или Imports (для Visual Basic) в начало файла кода.

    Imports Microsoft.VisualStudio.Tools.Applications

    using Microsoft.VisualStudio.Tools.Applications;

  8. Добавьте следующий код в метод Main. В этом коде объявляются следующие объекты:

    • Экземпляры типов AdventureWorksLTDataSet и ProductTableAdapter, заданных в проекте AdventureWorksDataSet.

    • Путь к книге AdventureWorksReport в папке построения проекта AdventureWorksReport.

    • Объект ServerDocument, используемый для доступа к кэшу данных в книге.

      Cc442984.alert_note(ru-ru,VS.90).gifПримечание.

      Следующий код предполагает, что используется книга Excel 2007 с расширением имени файла XLSX. Если книга в проекте имеет иное расширение имени файла, измените путь соответственно.

      		 
    Dim productDataSet As New AdventureWorksDataSet.AdventureWorksLTDataSet()
Dim productTableAdapter As _
    New AdventureWorksDataSet.AdventureWorksLTDataSetTableAdapters.ProductTableAdapter()

Dim workbookPath As String = System.Environment.GetFolderPath( _
    Environment.SpecialFolder.MyDocuments) & _
    "\AdventureWorksReport\bin\Debug\AdventureWorksReport.xlsx"
Dim serverDocument1 As ServerDocument = Nothing

    AdventureWorksDataSet.AdventureWorksLTDataSet productDataSet = 
    new AdventureWorksDataSet.AdventureWorksLTDataSet();
AdventureWorksDataSet.AdventureWorksLTDataSetTableAdapters.ProductTableAdapter productTableAdapter =
    new AdventureWorksDataSet.AdventureWorksLTDataSetTableAdapters.ProductTableAdapter();

string workbookPath = System.Environment.GetFolderPath(
    Environment.SpecialFolder.MyDocuments) +
    @"\AdventureWorksReport\bin\Debug\AdventureWorksReport.xlsx";
ServerDocument serverDocument1 = null;

  9. Добавьте следующий код в метод Main после кода, созданного на предыдущем шаге. Этот код выполняет следующие задачи:

    • Заполняет объект типизированного набора данных с помощью адаптера таблицы.

    • Использует свойство CachedData класса ServerDocument для доступа к кэшированному набору данных в книге.

    • Использует метод SerializeDataInstance для заполнения кэшированного набора данных данными из локального набора.

    Try
    productTableAdapter.Fill(productDataSet.Product)
    Console.WriteLine("The local dataset is filled.")

    serverDocument1 = New ServerDocument(workbookPath)
    Dim dataHostItem1 As CachedDataHostItem = _
        serverDocument1.CachedData.HostItems("AdventureWorksReport.Sheet1")
    Dim dataItem1 As CachedDataItem = dataHostItem1.CachedData("AdventureWorksLTDataSet")

    ' Initialize the worksheet dataset with the local dataset.
    If dataItem1 IsNot Nothing Then
        dataItem1.SerializeDataInstance(productDataSet)
        serverDocument1.Save()
        Console.WriteLine("The data is saved to the data cache.")
    Else
        Console.WriteLine("The data object is not found in the data cache.")
    End If
Catch ex As System.Data.SqlClient.SqlException
    Console.WriteLine(ex.Message)
Catch ex As System.IO.FileNotFoundException
    Console.WriteLine("The specified workbook does not exist.")
Finally
    If Not (serverDocument1 Is Nothing) Then
        serverDocument1.Close()
    End If
    Console.WriteLine(vbLf & vbLf & "Press Enter to close the application.")
    Console.ReadLine()
End Try

    try
{
    productTableAdapter.Fill(productDataSet.Product);
    Console.WriteLine("The local dataset is filled.");

    serverDocument1 = new ServerDocument(workbookPath);
    CachedDataHostItem dataHostItem1 =
        serverDocument1.CachedData.HostItems["AdventureWorksReport.Sheet1"];
    CachedDataItem dataItem1 = dataHostItem1.CachedData["adventureWorksLTDataSet"];

    // Initialize the worksheet dataset with the local dataset.
    if (dataItem1 != null)
    {
        dataItem1.SerializeDataInstance(productDataSet);
        serverDocument1.Save();
        Console.WriteLine("The data is saved to the data cache.");
        Console.ReadLine();
    }
    else
    {
        Console.WriteLine("The data object is not found in the data cache.");
    }
}
catch (System.Data.SqlClient.SqlException ex)
{
    Console.WriteLine(ex.Message);
}
catch (System.IO.FileNotFoundException)
{
    Console.WriteLine("The specified workbook does not exist.");
}
finally
{
    if (serverDocument1 != null)
    {
        serverDocument1.Close();
    }

    Console.WriteLine("\n\nPress Enter to close the application.");
    Console.ReadLine();
}

  10. В обозревателе решений щелкните правой кнопкой мыши проект DataWriter, выберите Отладка и нажмите кнопку Запустить новый экземпляр.

    Выполняется построение проекта, затем при считывании кэшированного набора данных в локальный набор данных и при сохранении приложением данных в кэшированный набор данных консольное приложение выводит несколько сообщений о состоянии. Чтобы закрыть приложение, нажмите клавишу ENTER.

Тестирование книги

При открытии книги ListObject теперь отображает данные, добавленные в кэшированный набор данных с помощью консольного приложения.

Тестирование книги

  1. Закройте книгу AdventureWorksReport в конструкторе Visual Studio, если она все еще открыта.

  2. В проводнике Windows откройте книгу AdventureWorksReport, находящуюся в папке построения проекта AdventureWorksReport. По умолчанию папка построения — это следующая папка:

    • %UserProfile%\Мои документы\AdventureWorksReport\bin\Debug (для Windows XP и более ранних версий)

    • %UserProfile%\Документы\AdventureWorksReport\bin\Debug (для Windows Vista)

  3. После открытия книги убедитесь, что объект ListObject заполнен данными.

Следующие действия

Подробные сведения о работе с кэшированными данными можно узнать в следующих разделах:

См. также

Задачи

Практическое руководство. Вставка данных в книгу на сервере

Пошаговое руководство. Изменение кэшированных данных в книге на сервере

Практическое руководство. Вставка данных в документы без записи на диск

Основные понятия

Общие сведения о подключении к данным в Visual Studio