チュートリアル : サーバー上のブックからのキャッシュされたデータの取得

[アーティクル]
08/09/2011

このチュートリアルでは、ServerDocument クラスを使用して、Microsoft Office Excel ブックにキャッシュされたデータセットから、Excel を起動することなくデータを取得する方法について説明します。このチュートリアルでは、「方法 : サーバー上のブックからキャッシュされたデータを取得する」に記載されているコード例を使用する場合の詳細な手順について説明します。

対象: このトピックの情報は、Excel 2007 と Excel 2010 のドキュメントレベルのプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクトタイプ別の使用可能な機能」を参照してください。

このチュートリアルでは、次の作業について説明します。

AdventureWorksLT データベースのデータを格納するデータセットを定義する。
Excel ブックプロジェクトおよびコンソールアプリケーションプロジェクトにデータセットのインスタンスを作成する。
ブックのデータセットにバインドされた ListObject を作成し、ブックが開かれたときに ListObject にデータを設定する。
ブックのデータセットをデータキャッシュに追加する。
Excel を起動することなく、キャッシュされたデータセットからコンソールアプリケーションのデータセットにデータを読み込む。

このチュートリアルでは開発用コンピューターでコードを実行することを想定していますが、このチュートリアルに掲載されているコードは、Excel がインストールされていないサーバー上でも実行できます。

注意

次の手順で参照している Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。これらの要素は、使用する Visual Studio のエディションとその設定によって決まります。詳細については、「設定の操作」を参照してください。

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

Microsoft Office 開発者ツールを含むエディションの Visual Studio 2010。 詳細については、「[Office ソリューションを開発できるようにコンピューターを構成する](bb398242\(v=vs.100\).md)」を参照してください。

Excel 2007 または Excel 2010
AdventureWorksLT サンプルデータベースがアタッチされた、Microsoft SQL Server または Microsoft SQL Server Express の実行中のインスタンスへのアクセス。 AdventureWorksLT データベースは、CodePlex の Web サイトからダウンロードできます。データベースを関連付ける方法の詳細については、以下のトピックを参照してください。
- SQL Server Management Studio または SQL Server Management Studio Express を使用してデータベースを関連付ける方法については、「データベースをアタッチする方法 (SQL Server Management Studio)」を参照してください。
- コマンドラインを使用してデータベースを関連付ける方法については、「データベースファイルを SQL Server Express にアタッチする方法」を参照してください。

データセットを定義するクラスライブラリプロジェクトの作成

Excel ブックプロジェクトとコンソールアプリケーションとで同じデータセットを使用するには、これらのプロジェクトの両方から参照される別個のアセンブリ内にデータセットを定義する必要があります。このチュートリアルでは、データセットをクラスライブラリプロジェクトに定義します。

クラスライブラリプロジェクトを作成するには

Visual Studio を起動します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
テンプレートペインで、[Visual C#] または [Visual Basic] を展開し、[Windows] をクリックします。
プロジェクトテンプレートの一覧で、[クラスライブラリ] を選択します。
[プロジェクト名] ボックスに「AdventureWorksDataSet」と入力します。
[参照] をクリックします。%UserProfile%\My Documents フォルダー (Windows XP 以前のバージョンの場合) または %UserProfile%\Documents (Windows Vista の場合) フォルダーに移動し、[フォルダーの選択] をクリックします。
[新しいプロジェクト] ダイアログボックスで、[ソリューションのディレクトリを作成] チェックボックスがオフになっていることを確認します。
[OK] をクリックします。

Visual Studio によって AdventureWorksDataSet プロジェクトがソリューションエクスプローラーに追加され、Class1.cs コードファイルまたは Class1.vb コードファイルが開かれます。
ソリューションエクスプローラーで、[Class1.cs] または [Class1.vb] を右クリックし、[削除] をクリックします。このファイルは、このチュートリアルには必要ありません。

クラスライブラリプロジェクトへのデータセットの定義

SQL Server 2005 用 AdventureWorksLT データベースのデータを格納する型指定されたデータセットを定義します。このチュートリアルの後半で、Excel ブックプロジェクトおよびコンソールアプリケーションプロジェクトからこのデータセットを参照します。

このデータセットは、AdventureWorksLT データベースの Product テーブルのデータを表す型指定されたデータセットです。型指定されたデータセットの詳細については、「Visual Studio でのデータセットの操作」を参照してください。

クラスライブラリプロジェクトに型指定されたデータセットを定義するには

ソリューションエクスプローラーで [AdventureWorksDataSet] プロジェクトをクリックします。
[データ] メニューの [新しいデータソースの追加] をクリックします。

データソース構成ウィザードが開きます。
[データベース] をクリックし、[次へ] をクリックします。
AdventureWorksLT データベースへの接続が既に設定されている場合は、その接続を選択し、[次へ] をクリックします。

それ以外の場合は、[新しい接続] をクリックし、[接続の追加] ダイアログボックスを使用して新しい接続を作成します。詳細については、「方法 : データベース内のデータに接続する」を参照してください。
[アプリケーション構成ファイルに接続文字列を保存] ページで、[次へ] をクリックしますSave the Connection String to the Application Configuration FileNext。
[データベースオブジェクトの選択] ページで、[テーブル] を展開し、[Product (SalesLT)] を選択します。
[完了] をクリックします。

AdventureWorksLTDataSet.xsd ファイルが AdventureWorksDataSet プロジェクトに追加されます。このファイルでは、次の項目を定義します。
- AdventureWorksLTDataSet という名前の型指定されたデータセット。このデータセットは、AdventureWorksLT データベースの Product テーブルの内容を表します。
- ProductTableAdapter という名前の TableAdapter。 TableAdapter は、AdventureWorksLTDataSet のデータを読み書きするために使用します。詳細については、「TableAdapter の概要」を参照してください。
これらのオブジェクトはどちらもこのチュートリアルの後半で使用します。
ソリューションエクスプローラーで、[AdventureWorksDataSet] を右クリックし、[ビルド] をクリックします。

プロジェクトがエラーを発生させずにビルドすることを確認します。

Excel ブックプロジェクトの作成

データとのインターフェイス用の Excel ブックプロジェクトを作成します。このチュートリアルの後半では、データを表示する ListObject を作成し、データセットのインスタンスをブック内のデータキャッシュに追加します。

Excel ブックプロジェクトを作成するには

ソリューションエクスプローラーで、[AdventureWorksDataSet] ソリューションを右クリックします。[追加] をポイントし、[新しいプロジェクト] をクリックします。
テンプレートペインで、[Visual C#] または [Visual Basic] を展開し、[Office] を展開します。
展開された [Office] ノードの下で、[2007] または [2010] ノードを選択します。
プロジェクトテンプレートの一覧で、Excel ブックプロジェクトを選択します。
[プロジェクト名] ボックスに「AdventureWorksReport」と入力します。場所は変更しないでください。
[OK] をクリックします。

Visual Studio Tools for Office プロジェクトウィザードが開きます。
[新規ドキュメントの作成] が選択されていることを確認し、[OK] をクリックします。

Visual Studio によって、デザイナーで AdventureWorksReport ブックが開かれ、ソリューションエクスプローラーに AdventureWorksReport プロジェクトが追加されます。

Excel ブックプロジェクトのデータソースへのデータセットの追加

Excel ブックにデータセットを表示するには、その前に Excel ブックプロジェクトのデータソースにデータセットを追加する必要があります。

Excel ブックプロジェクトのデータソースにデータセットを追加するには

ソリューションエクスプローラーで、[AdventureWorksReport] プロジェクトの下の [Sheet1.cs] または [Sheet1.vb] をダブルクリックします。

ブックがデザイナーで開かれます。
[データ] メニューの [新しいデータソースの追加] をクリックします。

データソース構成ウィザードが開きます。
[オブジェクト] をクリックし、[次へ] をクリックします。
[バインド先のオブジェクトを選択します] ページで、[参照の追加] をクリックします。
[プロジェクト] タブで、[AdventureWorksDataSet] をクリックし、[OK] をクリックします。
[AdventureWorksDataSet] アセンブリの [AdventureWorksDataSet] 名前空間の下にある [AdventureWorksLTDataSet] をクリックし、[完了] をクリックします。

[データソース] ウィンドウが開き、AdventureWorksLTDataSet がデータソースの一覧に追加されます。

データセットのインスタンスにバインドされた ListObject の作成

データセットをブックに表示するには、データセットのインスタンスにバインドされた ListObject を作成します。コントロールのデータへのバインドの詳細については、「Office ソリューションでのコントロールへのデータのバインド」を参照してください。

データセットのインスタンスにバインドされた ListObject を作成するには

[データソース] ウィンドウで、[AdventureWorksDataSet] の下にある [AdventureWorksLTDataSet] ノードを展開します。
[Product] ノードを選択し、表示されるドロップダウン矢印をクリックします。ドロップダウンリストで [ListObject] を選択します。

ドロップダウン矢印が表示されない場合は、デザイナーでブックが開かれていることを確認します。
Product テーブルをセル A1 にドラッグします。

productListObject という名前の ListObject コントロールが、セル A1 を始点にワークシートに作成されます。同時に、adventureWorksLTDataSet という名前のデータセットオブジェクトと、productBindingSource という名前の BindingSource がプロジェクトに追加されます。 ListObject が BindingSource にバインドされ、さらにこれがデータセットオブジェクトにバインドされます。

データキャッシュへのデータセットの追加

Excel ブックプロジェクトの外部のコードからブック内のデータセットにアクセスできるようにするには、データセットをデータキャッシュに追加する必要があります。データキャッシュの詳細については、「ドキュメントレベルのカスタマイズのキャッシュデータ」および「キャッシュされたデータ」を参照してください。

データキャッシュにデータセットを追加するには

デザイナーで、[adventureWorksLTDataSet] をクリックします。
[プロパティ] ウィンドウで、[Modifiers] プロパティを [Public] に設定します。
[CacheInDocument] プロパティを [True] に設定します。

ブック内のデータセットの初期化

コンソールアプリケーションを使用してキャッシュされたデータセットからデータを取得するには、その前にキャッシュされたデータセットにデータを設定する必要があります。

ブック内のデータセットを初期化するには

ソリューションエクスプローラーで Sheet1.cs ファイルまたは Sheet1.vb ファイルを右クリックし、[コードの表示] をクリックします。

Sheet1_Startup イベントハンドラーを次のコードで置き換えます。このコードでは、AdventureWorksDataSet プロジェクトに定義されている ProductTableAdapter クラスのインスタンスを使用して、キャッシュされたデータセットが現在空である場合にデータを設定します。

Private ProductTableAdapter As New  _
    AdventureWorksDataSet.AdventureWorksLTDataSetTableAdapters.ProductTableAdapter()

Private Sub Sheet1_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
    If Me.NeedsFill("AdventureWorksLTDataSet") Then
        Me.ProductTableAdapter.Fill(Me.AdventureWorksLTDataSet.Product)
    End If
End Sub

private AdventureWorksDataSet.AdventureWorksLTDataSetTableAdapters.ProductTableAdapter productTableAdapter =
    new AdventureWorksDataSet.AdventureWorksLTDataSetTableAdapters.ProductTableAdapter();

private void Sheet1_Startup(object sender, System.EventArgs e)
{
    if (this.NeedsFill("adventureWorksLTDataSet"))
    {
        this.productTableAdapter.Fill(this.adventureWorksLTDataSet.Product);
    }
}

チェックポイント

Excel ブックプロジェクトをビルドして実行して、エラーが発生することなくコンパイルおよび実行されることを確認します。また、この操作では、キャッシュされたデータセットにデータを設定し、データをブックに保存します。

プロジェクトをビルドして実行するには

ソリューションエクスプローラーで、[AdventureWorksReport] プロジェクトを右クリックします。[デバッグ] を選択し、[新しいインスタンスを開始] をクリックします。

プロジェクトがビルドされ、ブックが Excel で開かれます。次の点を確認します。
- ListObject にデータが格納されている。
- ListObject の最初の行の ListPrice 列の値が 1431.5 である。このチュートリアルの後半で、コンソールアプリケーションを使用して ListPrice 列の値を変更します。
ブックを保存します。ブックのファイル名または場所は変更しないでください。
Excel を終了します。

コンソールアプリケーションプロジェクトの作成

ブックのキャッシュされたデータセット内のデータを変更するコンソールアプリケーションプロジェクトを作成します。

コンソールアプリケーションプロジェクトを作成するには

ソリューションエクスプローラーで、[AdventureWorksDataSet] ソリューションを右クリックします。[追加] をポイントし、[新しいプロジェクト] をクリックします。
[プロジェクトの種類] ペインで、[Visual C#] または [Visual Basic] を展開し、[Windows] をクリックします。
[テンプレート] ペインで [コンソールアプリケーション] を選択します。
[プロジェクト名] に「DataReader」と入力します。場所は変更しないでください。
[OK] をクリックします。

Visual Studio によって DataReader プロジェクトがソリューションエクスプローラーに追加され、Program.cs コードファイルまたは Module1.vb コードファイルが開きます。

コンソールアプリケーションによるキャッシュされたデータセットからのデータの取得

データをローカル AdventureWorksLTDataSet オブジェクトに読み込むには、コンソールアプリケーションで ServerDocument クラスを使用します。キャッシュされたデータセットのデータを使用してローカルデータセットが初期化されていることを確認するために、ローカルデータセットの行数がアプリケーションによって表示されます。

キャッシュされたデータセットからデータを取得するには

ソリューションエクスプローラーで、[DataReader] プロジェクトを右クリックし、[参照の追加] をクリックします。
[.NET] タブで、[Microsoft.VisualStudio.Tools.Applications.ServerDocument] (DataReader プロジェクトが .NET Framework 4 を対象としている場合) または [Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0] (DataReader プロジェクトが .NET Framework 3.5 を対象としている場合) を選択します。
[OK] をクリックします。
ソリューションエクスプローラーで、[DataReader] プロジェクトを右クリックし、[参照の追加] をクリックします。
[プロジェクト] タブで、[AdventureWorksDataSet] を選択し、[OK] をクリックします。
コードエディターで Program.cs ファイルまたは Module1.vb ファイルを開きます。
コードファイルの先頭に次の using ステートメント (C# の場合) または Imports ステートメント (Visual Basic の場合) を追加します。
```
Imports Microsoft.VisualStudio.Tools.Applications
```
```
using Microsoft.VisualStudio.Tools.Applications;
```
Main メソッドに次のコードを追加します。このコードは、次のオブジェクトを宣言します。
- AdventureWorksDataSet プロジェクトに定義されている AdventureWorksLTDataSet 型のインスタンス
- AdventureWorksReport プロジェクトのビルドフォルダー内の AdventureWorksReport ブックへのパス
- ブックのデータキャッシュにアクセスするための ServerDocument オブジェクト
  
  注意
  
  次のコードでは、保存されたブックにファイル拡張子として.xlsx が使用されていると想定しています。プロジェクトのブックで異なるファイル拡張子を使用している場合は、必要に応じてパスを変更してください。
```
Dim productDataSet As New AdventureWorksDataSet.AdventureWorksLTDataSet()
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();
string workbookPath = System.Environment.GetFolderPath(
    Environment.SpecialFolder.MyDocuments) +
    @"\AdventureWorksReport\bin\Debug\AdventureWorksReport.xlsx";
ServerDocument serverDocument1 = null;
```

前の手順で追加したコードの後で、次のコードを Main メソッドに追加します。このコードは次のタスクを実行します。

ServerDocument クラスの CachedData プロパティを使用して、ブックのキャッシュされたデータセットにアクセスします。
キャッシュされたデータセットからローカルデータセットにデータを読み込みます。
データが格納されていることを示すために、ローカルデータセットの行数を表示します。

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

    If dataItem1 IsNot Nothing Then
        Console.WriteLine("Before reading data from the cache dataset, the local dataset has " & _
            "{0} rows.", productDataSet.Product.Rows.Count.ToString())

        ' Read the cached data from the worksheet dataset into the local dataset.
        Dim schemaReader As New System.IO.StringReader(dataItem1.Schema)
        Dim xmlReader As New System.IO.StringReader(dataItem1.Xml)
        productDataSet.ReadXmlSchema(schemaReader)
        productDataSet.ReadXml(xmlReader)

        Console.WriteLine("After reading data from the cache dataset, the local dataset has " & _
            "{0} rows.", productDataSet.Product.Rows.Count.ToString())
    Else
        Console.WriteLine("The data object is not found in the data cache.")
    End If
Catch ex As System.IO.FileNotFoundException
    Console.WriteLine("The specified workbook does not exist.")
Catch ex As System.Xml.XmlException
    Console.WriteLine("The data object has invalid XML information.")
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
{
    serverDocument1 = new ServerDocument(workbookPath);
    CachedDataHostItem dataHostItem1 =
        serverDocument1.CachedData.HostItems["AdventureWorksReport.Sheet1"];
    CachedDataItem dataItem1 = dataHostItem1.CachedData["adventureWorksLTDataSet"];

    if (dataItem1 != null)
    {
        Console.WriteLine("Before reading data from the cache dataset, the local dataset has " +
            "{0} rows.", productDataSet.Product.Rows.Count.ToString());

        // Read the cached data from the worksheet dataset into the local dataset.
        System.IO.StringReader schemaReader = new System.IO.StringReader(dataItem1.Schema);
        System.IO.StringReader xmlReader = new System.IO.StringReader(dataItem1.Xml);
        productDataSet.ReadXmlSchema(schemaReader);
        productDataSet.ReadXml(xmlReader);

        Console.WriteLine("After reading data from the cache dataset, the local dataset has " +
            "{0} rows.", productDataSet.Product.Rows.Count.ToString());
    }
    else
    {
        Console.WriteLine("The data object is not found in the data cache.");
    }
}
catch (System.IO.FileNotFoundException)
{
    Console.WriteLine("The specified workbook does not exist.");
}
catch (System.Xml.XmlException)
{
    Console.WriteLine("The data object has invalid XML information.");
}
finally
{
    if (serverDocument1 != null)
    {
        serverDocument1.Close();
    }

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

[ビルド] メニューの [DataReader のビルド] をクリックします。

プロジェクトのテスト

コンソールアプリケーションを実行すると、ローカルデータセットの行数が表示されます。

ブックをテストするには

ソリューションエクスプローラーで、[DataReader] プロジェクトを右クリックします。[デバッグ] をポイントし、[新しいインスタンスを開始] をクリックします。

ローカルデータセットの行数が 295 行であると報告されることを確認します。
Enter キーを押してアプリケーションを閉じます。

次の手順

キャッシュされたデータの操作については、以下のトピックを参照してください。

キャッシュされたデータセット内のデータを Excel を起動することなく初期化する。詳細については、「チュートリアル : サーバー上のブックへのデータの挿入」を参照してください。
キャッシュされたデータセット内のデータを Excel を起動することなく変更する。詳細については、「チュートリアル : サーバー上のブックにキャッシュされたデータの変更」を参照してください。

参照

処理手順

方法 : サーバー上のブックからキャッシュされたデータを取得する

方法 : サーバー上のブックにデータを挿入する

チュートリアル : サーバー上のブックへのデータの挿入

チュートリアル : サーバー上のブックにキャッシュされたデータの変更

概念

Windows フォームアプリケーションでのデータへの接続

Share via

チュートリアル : サーバー上のブックからのキャッシュされたデータの取得

必須コンポーネント

データセットを定義するクラスライブラリプロジェクトの作成

クラスライブラリプロジェクトを作成するには

クラスライブラリプロジェクトへのデータセットの定義

クラスライブラリプロジェクトに型指定されたデータセットを定義するには

Excel ブックプロジェクトの作成

Excel ブックプロジェクトを作成するには

Excel ブックプロジェクトのデータソースへのデータセットの追加

Excel ブックプロジェクトのデータソースにデータセットを追加するには

データセットのインスタンスにバインドされた ListObject の作成

データセットのインスタンスにバインドされた ListObject を作成するには

データキャッシュへのデータセットの追加

データキャッシュにデータセットを追加するには

ブック内のデータセットの初期化

ブック内のデータセットを初期化するには

チェックポイント

プロジェクトをビルドして実行するには

コンソールアプリケーションプロジェクトの作成

コンソールアプリケーションプロジェクトを作成するには

コンソールアプリケーションによるキャッシュされたデータセットからのデータの取得

キャッシュされたデータセットからデータを取得するには

プロジェクトのテスト

ブックをテストするには

次の手順

参照

処理手順

概念

その他のリソース

Share via

チュートリアル : サーバー上のブックからのキャッシュされたデータの取得

必須コンポーネント

データセットを定義するクラス ライブラリ プロジェクトの作成

クラス ライブラリ プロジェクトを作成するには

クラス ライブラリ プロジェクトへのデータセットの定義

クラス ライブラリ プロジェクトに型指定されたデータセットを定義するには

Excel ブック プロジェクトの作成

Excel ブック プロジェクトを作成するには

Excel ブック プロジェクトのデータ ソースへのデータセットの追加

Excel ブック プロジェクトのデータ ソースにデータセットを追加するには

データセットのインスタンスにバインドされた ListObject の作成

データセットのインスタンスにバインドされた ListObject を作成するには

データ キャッシュへのデータセットの追加

データ キャッシュにデータセットを追加するには

ブック内のデータセットの初期化

ブック内のデータセットを初期化するには

チェックポイント

プロジェクトをビルドして実行するには

コンソール アプリケーション プロジェクトの作成

コンソール アプリケーション プロジェクトを作成するには

コンソール アプリケーションによるキャッシュされたデータセットからのデータの取得

キャッシュされたデータセットからデータを取得するには

プロジェクトのテスト

ブックをテストするには

次の手順

参照

処理手順

概念

その他のリソース

データセットを定義するクラスライブラリプロジェクトの作成

クラスライブラリプロジェクトを作成するには

クラスライブラリプロジェクトへのデータセットの定義

クラスライブラリプロジェクトに型指定されたデータセットを定義するには

Excel ブックプロジェクトの作成

Excel ブックプロジェクトを作成するには

Excel ブックプロジェクトのデータソースへのデータセットの追加

Excel ブックプロジェクトのデータソースにデータセットを追加するには

データキャッシュへのデータセットの追加

データキャッシュにデータセットを追加するには

コンソールアプリケーションプロジェクトの作成

コンソールアプリケーションプロジェクトを作成するには

コンソールアプリケーションによるキャッシュされたデータセットからのデータの取得