指定した範囲の値をExcelファイルから読み込む「範囲を読み込む」アクティビティについてです。
1. アクティビティのプログラム名
RCA.Activities.Excel.ReadRange
2. 説明
Studio バージョン ~2.0.2.0
クイックアクセス: 「ツールボックス」 > 「Excel」 > 「範囲を読み込む」
Studio バージョン 2.0.3.0~
クイックアクセス: 「ツールボックス」 > 「Excel」 > 「ClosedXML」 > 「範囲を読み込む」
Excelファイルの指定した範囲からデータを読み込み、DataTable 変数に格納します。範囲を指定しない場合、シート全体を読み取ります。設定値としてセルを指定した場合、そのセルからシート全体を読み取ります。このアクティビティはExcel がインストールされていない場合も使用できます。
※動作を確認したコボットStudioのバージョン:2.0.1.6
※バージョンによって文言などが一部異なる場合がございます
3. プロパティ
プロパティ項目 | プロパティ名 | 入力欄 | 説明 |
---|---|---|---|
オプション | フォーマットを保持 | チェック項目 | チェックされている場合、書式が保持された文字列としてセルを読み込む。 |
ヘッダを追加 | チェック項目 | チェックした場合、読み込んだ範囲の先頭行をヘッダ行(項目行)として扱う。 | |
その他 | パブリック | チェック項目 | ログにアクティビティ内の変数と引数がログファイルに書き込まれ、Centerにプッシュされる。(詳細は「プロパティ項目「パブリック」について」を参照) |
表示名 | 任意の文字列 | デザイナーパネルのアクティビティ名に反映される。 | |
出力 | データテーブル | 値を入力 (DataTable型) | 読み込んだデータを格納する変数を設定する。 |
入力 | シート名 | 値を入力(String型) | 読み込むシート名を設定する。 |
ワークブックパス | 値を入力(String型) | 読み込む Excelファイルのパスを設定する。相対パスの場合、プロジェクトフォルダーが基準となる。 | |
範囲 | 値を入力(String型) | 読み込むセルの範囲を設定する。このプロパティを設定しない場合、シート全体を読み込む。設定値としてセルを指定した場合、そのセルからシート全体を読み込む。 |
4.使い方
プロジェクトフォルダにあるExcelファイル「読み込みサンプル.xlsx」を読み込む場合を見ていきましょう。
アクティビティ「Excel > 範囲を読み込む」を、ツールボックスからデザイナーパネルにドラッグ&ドロップで配置します。
アクティビティ内のプロパティ「入力 > ワークブックパス」を設定します。ボックスにファイルパス「"読み込みサンプル.xlsx"」と直接記述し設定する事もできますが、ここでは「Excelファイルを選択」ダイアログからファイルを選択していきます。プロパティの横にある「Excelファイルを選択」ダイアログ表示ボタンをクリックします。
Excelファイル「読み込みサンプル.xlsx」を選択し、「開く」ボタンをクリックします。
アクティビティ内の①プロパティ「入力 > シート名」に「"サンプル"」を、②プロパティ「入力 > 範囲」に「"A1:C4"」を設定します。※プロパティパネルからも設定できます。
「読み込みサンプル.xlsx」の1行目は、データではなく項目名です。「項目名」として読み込みたいため、プロパティパネルの「オプション > ヘッダの追加」をチェックします。
読み込んだデータを格納する変数を指定します。プロパティパネルの「出力 > データテーブル」にDataTable型の変数「dataTable」を設定します。変数が作成されていない場合、DataTable型の変数を作成し設定してください。「プロパティから作成する」で変数を作成すると、DataTable型で作成されます。※変数作成についての詳細は「変数の作成」を参照してください。
「ホーム > スタート」をクリック、または、「F5キー」押下で実行すると、「dataTable」に指定した範囲のデータが読み込まれます。※データテーブルを出力し確認する場合は、「データテーブルを出力」で文字列に変換し「1行を書き込む」で出力パネルに表示したり、「行ごとに処理」でメッセージボックスに表示してください。