「Excelシート名の一覧を取得」アクティビティについてです。
1.アクティビティのプログラム名
RCA.Activities.Excel.ExcelGetWorkbookSheets
2.説明
Studio バージョン ~2.0.2.0
クイックアクセス: 「ツールボックス」 > 「Excel」 > 「Excelシート名の一覧を取得」
Studio バージョン 2.0.3.0~
クイックアクセス: 「ツールボックス」 > 「Excel」 > 「Interop」 > 「Excelシート名の一覧を取得」
「Excelアプリケーションスコープ」アクティビティ内で使用します。既に存在しているExcelワークブック内に存在するシート名の一覧を取得します。
※動作を確認したコボットStudioのバージョン:2.0.1.8
※バージョンによって文言などが一部異なる場合がございます
3.プロパティ
プロパティ項目 | プロパティ名 | 入力欄 | 説明 |
---|---|---|---|
その他 | パブリック | チェック項目 | ログにアクティビティ内の変数と引数がログファイルに書き込まれ、Centerにプッシュされる。(詳細は「プロパティ項目「パブリック」について」を参照) |
表示名 | 任意の文字列 | デザイナーパネルのアクティビティ名に反映される。 | |
出力 | シート | 値を入力(List<String>型) | 取得したシート名の一覧を格納する。 |
4.使い方
プロジェクトフォルダ内にある「Excelシート名リスト出力サンプル.xlsx」ファイルに含まれているシート名を「出力」画面のログに表示する一連の流れをご紹介します。
「Excelシート名リスト出力サンプル.xlsx」には「赤」「青」「黄」「緑」のシートが含まれており、非表示になっているシートもありません。これらの4つのシート名を順番にログに表示させます。
まず、「Excel >Excelアプリケーションスコープ」アクティビティをドラッグアンドドロップでデザイナーパネルに配置します。
「ファイル>ワークブックパス」プロパティもしくはデザイナーパネル上のテキストボックス内に「"Excelシート名リスト出力サンプル.xlsx"」を入力します。今回はプロジェクトフォルダ内に配置しているワークブックのためファイル名のみ入れていますが、相対パスや絶対パスを入れても問題ありません。
次に、「Excel>Excelシート名の一覧を取得」アクティビティをドラッグアンドドロップでデザイナーパネルに配置します。
「出力>シート」プロパティに変数SheetsList(List<String>型)を設定します。変数の設定方法は「変数の作成」をご参照ください。これで、「Excelシート名リスト出力サンプル.xlsx」ファイルに含まれるシート一覧を変数SheetsListに格納できます。
変数SheetsListに格納したシート一覧をログに出力させます。「繰り返し(コレクションの各要素)」アクティビティと「ログにメッセージを出力」アクティビティを使用して一行ずつ書き出します。
「繰り返し(コレクションの各要素)」アクティビティをドラッグアンドドロップでデザイナーパネルに配置します。
次の項目を設定、入力します。
- 「その他>TypeArgument」プロパティを「String」にします
- 「出力>現在のインデックス」プロパティに変数ListIndex(Int32型)を設定します
- 「入力>値」プロパティに変数SheetsListを入力します
- デザイナーパネル内の「Foreach」に「Name」を入力します
ログに表示するため、「コア>ログにメッセージを出力」アクティビティをドラッグアンドドロップでデザイナーパネルに配置します。
「入力>メッセージ」プロパティに「 (ListIndex + 1).ToString + "つ目のシート:" + Name 」を入力します。(ListIndexは0から表示されるため、わかりやすくするために1を足しています)
「ホーム > スタート」をクリック、または、「F5キー」押下で実行します。「出力」を開きログを確認すると、指定した文章と共にシート名が表示されています。
もしExcelワークブックの一部のシートが非表示になっていた場合、非表示のシートも含めて変数SheetsListに格納されます。