Microsoft Excel コネクタのメソッド
Microsoft Excel コネクタのメソッドを使用して、Microsoft Excel ドキュメントに対してさまざまなアクションを実行できます。自動化フローでは、メソッドは他のメソッドやコンポーネントに接続されます。メソッドを使用するには、まずメソッドを公開する必要があります。
オープン
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath |
メソッドが開く既存のファイルへのパスです。 ファイルを作成するには、CreateNewFile パラメーターの値を True に設定する必要があります。 注:
パスにはファイル名を含める必要があります。 |
データ入力 | 文字列 |
| CreateNewFile | 指定したファイルが存在しない場合に、新しい Excel ファイルを作成するかどうかを指定します。 CreateNewFile パラメーターが true に設定されている場合、指定されたファイルパスに新しいファイルが作成されます。False に設定すると、指定されたファイルパスから Excel を開こうとします。 |
データ入力 | ブーリアン |
| DisplayAlerts | Excel を開くプロセス中にアラートまたはプロンプトを表示するかどうかを指定します。 true に設定すると、ファイルの競合や互換性などの問題に関するアラートが Excel に表示されます。false に設定すると、これらのアラートは抑制されます。 |
データ入力 | ブーリアン |
| IsVisible | ファイルを開いたときに Excel アプリケーションウィンドウをユーザーに表示するかどうかを指定します。 true に設定すると、Excel ウィンドウが画面に表示されます。false に設定すると、Excel はインターフェイスを表示せずにバックグラウンドで実行されます。 |
データ入力 | ブーリアン |
| ReadOnlyMode | Excel ファイルを読み取り専用モードで開くかどうかを指定します。 true に設定すると、ファイルは読み取り専用モードで開き、変更が行われるのを防ぎます。false に設定すると、ファイルは通常モードで開き、変更が可能になります。 |
データ入力 | ブーリアン |
| Password | Excel ファイルがパスワードで保護されている場合に、そのファイルを開くために必要なパスワード。 ファイルがパスワードで保護されていない場合は、このパラメーターを空白のままにしておくことができます。 |
データ入力 | 文字列 |
| Return | True 値または False 値を返します。値が True の場合、ファイルが正常に開かれるか作成されます。 | データ出力 | ブーリアン |
AddNewWorkSheet
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | メソッドがファイルに追加する新しいワークシートの名前。 | データ入力 | 文字列 |
AutoFill
隣接するセルの内容または事前定義されたパターンに基づいて、指定された範囲内のセルに自動的に入力します。このメソッドは、複数のセル間でデータをコピーしたり、書式設定したりする場合に便利です。Microsoft Excel は、初期選択の内容を分析し、推定した内容を目的の範囲に入力します。一連の数値の拡張、数式の複製、テキストパターンの複製、またはその他のデータ入力処理の実行に使用できます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| SourceRange | 複製するデータまたは数式を含むセル範囲。 | データ入力 | 文字列 |
GetSheetNames
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | 開いている Microsoft Excel ドキュメント内のシートの名前を返します。 | データ出力 | 文字列 |
Close
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| saveChanges | 値が True に設定されている場合、閉じる前にファイルへの変更は保存されます。False に設定されている場合、変更は保存されません。 | データ入力 | ブーリアン |
ColumnsCount
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | メソッドが列数のカウントに使用するシートの名前。 | データ入力 | 文字列 |
| Return | ワークシートの列数を返します。 | データ出力 | 整数 |
Copy
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | ソースデータを含むシートの名前。 | データ入力 | 文字列 |
| Cellrange | コピーするセルの範囲です。 | データ入力 | 文字列 |
Paste
クリップボードの内容を、ワークシートの CellLocation パラメーターで指定された特定のセルに貼り付けます。また、複数セルの範囲に張り付けることもできます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | クリップボードの内容が貼り付けられるシートの名前。 | データ入力 | 文字列 |
| CellLocation | クリップボードの内容が貼り付けられる場所 (セル参照) を示します。 | データ入力 | 文字列 |
FillBlankValues
Microsoft Excel ファイルのワークシートの指定された列の空のセルに指定された値を入力します。ワークシートを指定するための SheetName パラメーター、列を識別するための ColumnName パラメーター、空のセルを置き換える値を指定するための Value パラメーターが必要です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | 空白の値を埋めるシートの名前。 | データ入力 | 文字列 |
| ColumnName | 値を入力する必要があるワークシートの列の名前。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| Value | 列に入力する値。 | データ入力 | 文字列 |
CreateChart
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | チャートが作成されるシートの名前。 | データ入力 | 文字列 |
| CellRange | チャートの作成元となるセル範囲。 | データ入力 | 文字列 |
| ChartType | 作成するチャートのタイプを指定します。 使用可能なチャートの種類は、使用している Excel コネクタの特定の実装によって異なります。 |
データ入力 | ExcelChartType |
| Return | True の場合、チャートは正常に作成されています。False の場合、チャートの作成は失敗しています。 | データ出力 | ブーリアン |
CreatePivotTable
[ピボットテーブルの設定 (Pivot Table Settings)] ウィンドウで構成された設定を使用して、指定されたシートにピボットテーブルを生成します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ピボットテーブルの作成元となるシートの名前。 | データ入力 | 文字列 |
| PivotTableName | ピボットテーブルの名前。 | データ入力 | 文字列 |
DeleteColumn
列の指定されたインデックスに基づいて、指定されたシートの列を削除します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 列が削除されるシートの名前。 | データ入力 | 文字列 |
| ColumnIndex | 削除する必要がある列のインデックス。 Excel では、列にはアルファベット順 (A、B、C など) のラベルが付けられ、各列には対応する数値インデックス (列 A は 1、列 B は 2 など) があります。 |
データ入力 | 整数 |
| Return | 列が削除されたかどうかを示すブール値を返します。True の場合、列は削除されています。False の場合、列は削除されていません。 | データ出力 | ブーリアン |
DeleteContentFromRange
指定されたセル範囲から内容を削除します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 内容が削除されるシートの名前。 | データ入力 | 文字列 |
| CellRange | データを削除するセルの範囲を指定します。 | データ入力 | 文字列 |
| Return | セルの範囲からの内容が削除されたかどうかを示すブール値を返します。True の場合、内容は削除されています。False の場合、内容は削除されていません。 | データ出力 | ブーリアン |
DeleteEmptyColumns
Microsoft Excel ファイルの指定されたワークシートで内容がない列を削除します。このメソッドでは、ワークシートを識別するために SheetName パラメーターが必要です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 空の列を含むシートの名前。 | データ入力 | 文字列 |
DeleteEmptyRows
Microsoft Excel ファイルの指定されたワークシートで内容がない行を削除します。このメソッドでは、ワークシートを識別するために SheetName パラメーターが必要です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 空の行を含むシートの名前。 | データ入力 | 文字列 |
DeleteRow
RowNumber パラメーターに基づいてワークシートから行を削除します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 行が削除されるシートの名前。 | データ入力 | 文字列 |
| RowNumber | 削除する必要がある行の番号を示します。 | データ入力 | 整数 |
| Return | 行が削除されているかどうかを示すブール値を返します。True の場合、行は削除されています。False の場合、行は削除されていません。 | データ出力 | ブーリアン |
DeleteWorksheet
指定されたワークシートを削除します。このメソッドでは、ワークシートを識別するために SheetName パラメーターが必要です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 削除される必要があるシートの名前。 | データ入力 | 文字列 |
| Return | ワークシートが削除されたかどうかを示すブール値を返します。True の場合、ワークシートは削除されています。False の場合、ワークシートは削除されていません。 | データ出力 | ブーリアン |
ExportChartAsImages
シート内に存在するチャートを、指定したパスに保存された画像ファイルにエクスポートして保存します。このプロセスにより、チャートが Excel ワークブックから分離され、簡単に共有したり、さまざまなドキュメント、プレゼンテーション、またはレポートに挿入したりできるスタンドアロンの視覚的表現が提供されます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | グラフを含むシートの名前。 | データ入力 | 文字列 |
| SaveFolderpath | チャートが画像ファイルとして保存されるフォルダパスを指定します。 | データ入力 | 文字列 |
ExportToPDF
Excel ファイルを PDF ファイルとして、FilePath パラメーターで指定されたパスの場所にエクスポートします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | PDF ファイルのエクスポート先のファイルパスを指定します。 | データ入力 | 文字列 |
FindAndReplace
SheetName パラメーターで指定されたワークシート内の FindText パラメーターで指定されたテキストを検索し、それを ReplaceTo パラメーターで指定された別のテキストに置き換えます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | テキストが置換されるワークシートの名前。 | データ入力 | 文字列 |
| FindText | ワークシートのセル内で検索されるテキスト。 | データ入力 | 文字列 |
| ReplaceTo | FindText パラメーターを使用して検索されたテキストを置き換えるためのテキスト。 | データ入力 | 文字列 |
| Return | テキストが置換されているかどうかを示すブール値を返します。True の場合、テキストは置換されています。False の場合、テキストは置換されていません。 | データ出力 | ブーリアン |
GetActiveSheetName
アクティブなワークシートの名前を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | 文字列形式でアクティブなワークシートの名前を返します。 | データ出力 | 文字列 |
GetCellAddressIfRowHas
指定されたシート内の指定されたテキストを検索します。指定された行インデックスから開始して、指定された列名をスキャンします。テキストが見つかった場合は、true を返します。見つからない場合は false を返します。さらに、一致したセルアドレスを構成値に格納できます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 検索するワークシートの名前。 | データ入力 | 文字列 |
| SearchText | 指定した列内で検索するテキスト。 | データ入力 | 文字列 |
| SearchColumn | 検索が実行される列。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| StartRowIndex | 検索を開始する行インデックス。 | データ入力 | 整数 |
| Return | SearchText が見つかったかどうかを示すブール値を返します。True の場合、テキストが見つかっています。False の場合、テキストは見つかっていません。 | データ出力 | ブーリアン |
GetCellFormula
ワークシートからセルの数式を取得します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | セルの数式の取得元となるワークシートの名前。 | データ入力 | 文字列 |
| CellName | 数式の取得元となるセルの名前または参照を指定します。 | データ入力 | 文字列 |
| Return | 指定されたセルの数式を文字列形式で返します。 | データ出力 | 文字列 |
GetCellValue
CellName パラメーターで指定されたワークシートからセルの値を取得します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | セル値の取得元となるワークシートの名前。 | データ入力 | 文字列 |
| CellName | GetCellValue で設定された構成に基づいて、セル値を返すか、テキストを表示します。 | データ入力 | 文字列 |
| Return | 指定されたセルの値を文字列形式で返します。 | データ出力 | 文字列 |
GetCellValueIfRowHas
指定されたシートで指定されたテキストを検索します。指定された行インデックスから開始して、指定された列をスキャンします。テキストが見つかった場合は、true を返します。見つからない場合は false を返します。さらに、一致したセル値を構成値に格納できます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 検索するワークシートの名前。 | データ入力 | 文字列 |
| SearchText | 指定した列内で検索するテキスト。 | データ入力 | 文字列 |
| SearchColumn | 検索が実行される列。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| StartRowIndex | 検索を開始する行インデックス。 | データ入力 | 整数 |
| Return | SearchText が見つかったかどうかを示すブール値を返します。True の場合、テキストが見つかっています。False の場合、テキストは見つかっていません。 | データ出力 | ブーリアン |
GetCellValues
ワークシートからセルの値を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
GetColor
ワークシートの CellName パラメーターで指定されたセルの RGB 値を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | セルの色の取得元となるワークシートの名前。 | データ入力 | 文字列 |
| CellName | 色を取得するセルの名前または参照。 | データ入力 | 文字列 |
| Return | 指定されたセルの色を文字列形式で返します。 | データ出力 | 文字列 |
GetColumnNameByIndex
指定された列番号に対応する列名を返します。たとえば、1 に対応する「A」など。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| ColumnNumber | 名前を取得する列番号。 | データ入力 | 整数 |
| Return | 列の名前を文字列形式で返します。 | データ出力 | 文字列 |
GetFilterData
指定されたフィルター基準に基づいて、ワークシートからフィルター済みデータを返します。データの取得は、RowNumber パラメーターで指定された行番号から開始されます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| RowNumber | データ抽出の開始行である行の行番号。 | データ入力 | 整数 |
| FirstRowAsHeader | フィルタリングされたデータの最初の行をヘッダー行として扱うかどうかを決定します。true に設定すると、最初の行はヘッダー行と見なされ、抽出されたデータ行には含まれません。false に設定すると、最初の行は抽出されたデータ行の一部として含まれます。 | データ入力 | ブーリアン |
| Return | フィルタリングされたデータをテーブル形式で返します。操作は、このテーブルの行と列に対して実行できます。 | データ出力 | データテーブル |
GetFilteredDataAddress
SheetName パラメーターで指定されたワークシート内のフィルター処理されたデータのアドレスを返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | フィルター処理されたデータのアドレスの取得元となるワークシートの名前。 | データ入力 | 文字列 |
| Return | 文字列がフィルター処理されたデータアドレスである文字列のリストまたはコレクションを返します。 | データ出力 | リスト (文字列) |
GetRowValues
値の抽出元となる指定された SheetName パラメーターからセル値を返します。既定では、RowNumber が指定されていない (または -1 に設定されている) 場合、最後の行から値が読み取られます。さらに、列名を追加するための出力パラメーターを含めて、その値を出力に格納できます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 値の取得元となるワークシートの名前を指定します。 | データ入力 | 文字列 |
| RowNumber | 値の読み取り元の行。-1 に設定すると、最後の行がデフォルトになります。 | データ入力 | 整数 |
GetSelectedRange
SheetName パラメーターで指定されたワークシートから、現在選択されているセル範囲を返します。データは、強調表示または選択されたワークシートの特定の領域から抽出されます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| Return | シートで選択されているセル範囲を文字列形式で返します。 | データ出力 | 文字列 |
GetSheetNames
Excel ファイルに存在するすべてのワークシート名のリストを返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | 利用可能なすべてのシート名を文字列アレイ形式で返します。 | データ出力 | 文字列[] |
GetUsedRange
指定されたシートの使用済みセルの範囲を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 範囲の読み取り元のワークシートの名前。 | データ入力 | 文字列 |
| IncludeHeaders | ヘッダーを含めるかどうかを示します。 | データ入力 | ブーリアン |
| Return | 使用されているセルの範囲を文字列形式で返します。 | データ出力 | 文字列 |
GetValuesByColumn
Distinct、FirstRowAsHeader、および ValueType の各パラメーター基準に基づいて、指定された SheetName の指定された ColumnName から値のリストを返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| ColumnName | 値の取得元の列の名前を示します。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| FirstRowAsHeader | 指定した列の最初の行にヘッダーが含まれているかどうかを示します。 | データ入力 | ブーリアン |
| Distinct | 取得する値が固有または一意である必要があるかを指定します。 | データ入力 | ブーリアン |
| ValueType | 可視性に基づいて値を抽出します。 | データ入力 | 値 |
| Return | 行数を返します。 | データ出力 | 整数 |
InsertNewColumn
指定されたワークシートの ColumnNumber パラメーターで指定されたインデックスに新しい列を挿入します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 列を挿入する必要があるワークシートの名前。 | データ入力 | 文字列 |
| ColumnIndex | 新しい列が挿入される列のインデックスを指定します。たとえば、1 は A、2 は B のようになります。 | データ入力 | 整数 |
InsertNewRow
指定されたワークシートの指定されたインデックスに新しい行を挿入します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 行が挿入されるワークシートの名前。 | データ入力 | 文字列 |
| RowIndex | 行のインデックスです。行は指定されたインデックスに挿入されます。 | データ入力 | 整数 |
| Return | 行が挿入されているかどうかを示すブール値を返します。True の場合、行は挿入されています。False の場合、行は挿入されていません。 | データ出力 | ブーリアン |
InsertObject
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | メソッドがオブジェクトを挿入するワークシートの名前。 | データ入力 | 文字列 |
| CellName | メソッドがオブジェクトを挿入するセルの名前。たとえば、A1 などです。 | データ入力 | 文字列 |
| Filepath | メソッドが挿入するオブジェクトのファイルパス。 | データ入力 | 文字列 |
IsOpen
Filepath パラメーターで指定された場所にある Microsoft Excel ワークブックまたはファイルが開いているかどうかを確認します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | ローカルドライブ内の Excel ファイルへのパス。 | データ入力 | 文字列 |
| Return | Excel ファイルが開いているかどうかを示すブール値を返します。True の場合、 Excel ファイルは開いています。False の場合、Excel ファイルは開いていません。 | データ出力 | ブーリアン |
MergeCells
指定されたワークシートの範囲内で指定されたセルを結合します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | セルが結合されるワークシートの名前。 | データ入力 | 文字列 |
| CellRange | セルの範囲です。範囲内のすべてのセルが結合されます。 | データ入力 | 文字列 |
ReadFromRange
指定されたワークシートからデータを取得し、そのデータを返します。どのワークシートからセル範囲を抽出するかを示すワークシート名を指定し、読み取るセルの範囲を決定するセル範囲を指定して、FirstRowAsHeader パラメーターで最初の行がヘッダーであるかどうかを示す必要があります。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | メソッドがデータ読み取るワークシートの名前。 | データ入力 | 文字列 |
| CellRange | セルの範囲です。メソッドはこれらのセルからデータを読み取ります。 | データ入力 | 文字列 |
| FirstRowAsHeader | メソッドが最初の行をヘッダーとして扱うかどうかを示すブール値です。True の場合、最初の行はヘッダーとして扱われます。False の場合、最初の行はヘッダーとして扱われません。 | データ入力 | ブーリアン |
| Return | セルのデータで構成されるデータテーブルを返します。 | データ出力 | データテーブル |
ReadFromSheet
ワークシートからデータを抽出し、DataTable などの構造化形式に変換します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | メソッドがデータを読み取るワークシートの名前。 | データ入力 | 文字列 |
| Return | 指定されたワークシート内のすべてのデータを返します。 | データ出力 | データテーブル |
RenameSheetName
既存のワークシートの名前を変更します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| OldSheetName | ワークシートの既存の名前。 | データ入力 | 文字列 |
| NewSheetName | ワークシートの新しい名前。 | データ入力 | 文字列 |
| Return | ワークシートの名前が変更されているかどうかを示すブール応答を返します。True の場合、ワークシートの名前が変更されています。False の場合、ワークシートの名前は変更されていません。 | データ出力 | ブーリアン |
RowsCount
指定されたワークシート内の行数を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 返す行数のワークシートの名前。 | データ入力 | 文字列 |
| Return | 行数を返します。 | データ出力 | 整数 |
RunMacro
Excel ファイル内の既存のマクロを実行します。このメソッドには、ユーザーが実行しようとしているマクロの名前が必要です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| MacroName | 実行するマクロの名前。 | データ入力 | 文字列 |
| Return | マクロが正常に実行されたかどうかを示すブール値を返します。 | データ出力 | ブーリアン |
Resize
Excel アプリケーションウィンドウの幅と高さのサイズを変更します。Excel アプリケーションのレイアウトと外観は、特定の表示要件に合わせてカスタマイズできます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Left | このパラメーターは、Excel アプリケーションウィンドウの左上隅の水平方向の位置を、画面の左端からの距離で指定します。画面の左端から Excel ウィンドウの左端までの距離をピクセル単位またはポイント単位で定義します。 | データ入力 | 整数 |
| Top | このパラメーターは、Excel アプリケーションウィンドウの左上隅の垂直方向の位置を、画面の上端からの距離で示します。画面の上端から Excel ウィンドウの上端までの距離をピクセル単位またはポイント単位で定義します。 | データ入力 | 整数 |
| Width | このパラメーターは、Excel アプリケーションウィンドウの幅をピクセル単位またはポイント単位で指定します。ウィンドウの左端から右端までの水平方向のサイズを決定します。 | データ入力 | 整数 |
| Height | このパラメーターは、Excel アプリケーションウィンドウの高さをピクセル単位またはポイント単位で指定します。ウィンドウの上端から下端までの垂直方向のサイズを定義します。 | データ入力 | 整数 |
RemoveFilter
SheetName パラメーターで指定されたワークシートからフィルターを削除します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | メソッドがフィルターを削除するワークシートの名前。 | データ入力 | 文字列 |
Save
Microsoft Excelドキュメント内のデータまたは書式に加えられた更新、変更、追加、または削除を保存して、作業が保持され、Excel ファイルに最新の更新内容が反映されるようにします。
SaveAs
Excel ファイルを Filepath パラメーターで指定されたファイルパスに別の名前または形式で保存します。また、Password パラメーターに値を指定することで、ファイルをパスワードで保護することもできます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | Excel ファイルが別の名前または形式で保存される場所のファイルパス。 | データ入力 | 文字列 |
| Password | 保存される Excel ファイルを保護するためのパスワード。このパラメーターはオプションであり、デフォルト値は空の文字列です。 | データ入力 | 文字列 |
SaveCopyAs
Excel ファイルのコピーを、保存先として指定されたパスに保存します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | Excel ファイルが別の名前または形式で保存される場所のファイルパス。 | データ入力 | 文字列 |
| Password | 保存される Excel ファイルを保護するためのパスワード。このパラメーターはオプションであり、デフォルト値は空の文字列です。 | データ入力 | 文字列 |
SelectRange
Excel ワークシート内のセルの範囲を指定して強調表示します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| CellRange | 指定したワークシート内で選択されているセル範囲。これは、通常、開始セル参照と終了セル参照によって識別され、強調表示またはアクティブ化されるセルのグループを定義します。 | データ入力 | 文字列 |
SelectRowByIndex
ワークシートの RowNumber パラメーターで指定されたインデックスに基づいて、行全体を選択します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 行が選択されるワークシートの名前。 | データ入力 | 文字列 |
| RowNumber | 選択される行のインデックス。 | データ入力 | 整数 |
SetActiveWorksheet
Sheetname で指定されたワークシートをアクティブなワークシートとしてマークします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | アクティブとして設定する必要があるワークシートの名前。 | データ入力 | 文字列 |
| Return | 指定されたシートがアクティブとして設定されているかどうかを示すブール値を返します。 | データ出力 | ブーリアン |
SetAlignment
CellRange で指定されたセルの配置設定を調整して、Excel ワークシート内のデータの表示と外観を制御し、スプレッドシートデータの視覚的効果と読みやすさを向上させ、データのプレゼンテーションと情報伝達を改善します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| CellRange | 配置の設定またはプロパティが適用されるセルの範囲。 | データ入力 | 文字列 |
| HorizantalAlignment | 指定された範囲内のセルのコンテンツの水平配置。コンテンツ (テキストや数値など) を各セル内で水平方向にどのように配置するかを決定します。可能な値には、左揃え、中央揃え、右揃え、両端揃え、または均等割り付けがあります。 | データ入力 | HorizantalAlignment |
| VerticalAlignment | 指定された範囲内のセルコンテンツの垂直配置。コンテンツが各セル内で垂直方向にどのように配置されるかを決定します。可能な値には、上揃え、上下中央揃え、下揃え、または両端揃えがあります。 | データ入力 | VerticalAlignment |
SetCellColor
ワークシートの CellName パラメーターで指定された特定のセルに、Color パラメーターで指定された色を設定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | セルが配置されているワークシートの名前。 | データ入力 | 文字列 |
| CellName | 色を設定するセルの名前または参照を示します。 | データ入力 | 文字列 |
| Color | セルに適用する RGB カラー値を指定します。 | データ入力 | ExcelRgbColor |
| Return | 指定された特定のセルに数式が設定されているかどうかを示すブール値を返します。 | データ出力 | ブーリアン |
SetCellFormula
Excel ファイルの指定されたセルに計算式を割り当てます。このメソッドでは、設定するワークシート、セル、および数式を決定するために、それぞれ SheetName、CellName、および Formula パラメーターが必要です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | アクションが実行されるワークシートの名前。 | データ入力 | 文字列 |
| CellName | 操作が行われるワークシート内のセル。 | データ入力 | 文字列 |
| Formula | 指定されたセルに適用される数式または論理式。 | データ入力 | 文字列 |
| Return | 指定されたセルに数式が設定されているかどうかを示すブール値を返します。 | データ出力 | ブーリアン |
SetCellValue
ワークシートの特定のセルに値を割り当て、そのセルの既存のコンテンツを置き換えます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| CellName | このパラメーターは、指定されたワークシート内のターゲットセルの参照または識別子を示します。これは、セルアドレスで表すことができます (例:「A1」、「B2」、「C3」)。 | データ入力 | 文字列 |
| Value | 指定したセルに割り当てられる値で、数値、文字列、日付、数式、論理値など、Excel でサポートされている任意のデータ型にすることができます。 | データ入力 | 文字列 |
SetCellValue
メソッドエディターダイアログで設定されたとおりに、指定されたシート内の複数のセルに値を設定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | セル値が設定されるワークシートの名前。 | データ入力 | 文字列 |
SetCellValuesIfRowHas
指定されたシートで指定されたテキストをスキャンし、指定された列名を指定された行インデックスから調べます。テキストが見つかった場合は、指定されたセルの値を指定された値に設定します。値が正常に設定された場合は true を返し、それ以外の場合は false を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 検索するワークシートの名前。 | データ入力 | 文字列 |
| SearchText | 指定した列内で検索するテキスト。 | データ入力 | 文字列 |
| SearchColumn | 検索が実行される列。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| StartRowIndex | 検索を開始する行インデックス。 | データ入力 | 整数 |
| Return | 指定された列で SearchText が見つかった場合は True を返します。見つからない場合は False を返します。 | データ出力 | ブーリアン |
SetColumnType
ワークシート内の指定された列のデータ型を変更します。たとえば、数値を含む列をテキスト形式に変換したり、テキストデータの列を数値形式に変更したりできます。分析やレポート作成のニーズに合わせてデータ形式を調整し、データの表示の一貫性と精度を確保することができます。Excel でのデータ変換、書式設定、操作などのタスクに役立ちます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| FormatType | 変換後の列の形式タイプ。このパラメーターは、列内のデータの解釈方法または表示方法を決定します。可能な値には、数値、テキスト、日付、時刻、通貨、パーセンテージ、またはカスタム形式が含まれます。 | データ入力 | 文字列 |
| Column | データ型が変更される、指定されたワークシート内の列の参照または識別子。列の文字で表すことができます (例:「A」、「B」、「C」)。 | データ入力 | 文字列 |
| Return | 列タイプが設定されているかどうかを識別するブール値を返します。 | データ出力 | ブーリアン |
SetColumnWidth
width パラメーターで指定されるすべての列の幅を設定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 列の幅が調整されるワークシートの名前。 | データ入力 | 文字列 |
| Width | 列が設定される文字数の幅。 整数値のみを使用できます。小数値は使用できません。 |
データ入力 | 整数 |
| Return | 列タイプが設定されているかどうかを識別するブール値を返します。 | データ出力 | ブーリアン |
SetFilter
特定の列にフィルターを適用します。このメソッドは、指定されたシート名に基づいてワークシートを検索し、指定されたフィルター値を適用します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 列が配置されているワークシートの名前。 | データ入力 | 文字列 |
| ColumnName | フィルターが適用される列。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| FilterValue | 識別された列内でフィルターにかける値。 | データ入力 | 文字列 |
SetFilterByRow
指定された列に、指定された行番号から開始してフィルターを適用します。このメソッドは、指定されたシート名に基づいてワークシートを検索し、指定されたフィルター値を適用します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| RowNumber | 指定されたワークシート内で、フィルター条件が定義されている行番号を示します。データのフィルターに使用される条件を含む行を識別します。 | データ入力 | 整数 |
| ColumnName | フィルタリングが実行される列の名前または識別子。フィルタリング基準が適用される列を表します。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 指定された ColumnName は、データの開始列に相対する列名を参照します。たとえば、データが Excel シートの列 B から始まる場合、相対する列インデックス A は列 B に対応し、相対する列インデックス B は列 C に対応します。 |
データ入力 | ColumnName |
| FilterValue | フィルター基準として使用される値または条件。これは、指定された列のデータがフィルター適用後も表示されるために一致する必要がある特定の値を表します。 | データ入力 | 文字列 |
SetFontStyle
Color、FontStyle、FontName、Bold、Underline などのパラメーターを設定して、指定した範囲内のセルを書式設定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | フォントスタイルが設定されるワークシートの名前。 | データ入力 | 文字列 |
| CellRange | フォントスタイルを設定するセル範囲。 | データ入力 | 文字列 |
| Color | フォントの RGB カラー値を指定します。 | データ入力 | ExcelRgbColor |
| FontSize | フォントのサイズを指定します。デフォルト値は 11 です。 | データ入力 | 整数 |
| FontName | フォントの名前を指定します。デフォルト値は Calibri です。 | データ入力 | 文字列 |
| Bold | フォントを太字にするかどうかを示します。デフォルト値は False です。 | データ入力 | ブーリアン |
| Underline | フォントの下線のスタイルを指定します。デフォルト値は「なし」です。 | データ入力 | Underline |
SetRowHeight
Excel ワークシート内の特定の行の高さを変更します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | 行が配置されているワークシートの名前。 | データ入力 | 文字列 |
| Height | 希望の高さを指定します。 | データ入力 | 整数 |
| StartIndex | 開始行インデックス。 | データ入力 | 文字列 |
| EndIndex | 終了行インデックス。 | データ入力 | 文字列 |
| Return | 行の高さが正常に設定されたかどうかを示すブール値を返します。 | データ出力 | ブーリアン |
SetRowValues
Excel スプレッドシートの特定の行に値を設定します。デフォルトでは、RowIndex パラメーターが -1 に設定されている場合、関数はスプレッドシートの末尾に値を挿入します。つまり、特定の行インデックスを指定しない場合、スプレッドシート内の既存のデータの末尾に値が追加されます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| RowNumber | 値が設定または更新される行番号を示します。Excel では、行番号は上から下に向かって順に 1 から始まり、連続して番号が付けられます。RowNumber を指定することで、値が配置される特定の行を指定します。RowNumber として -1 が渡された場合、通常、スプレッドシートの最後に値が挿入されることを示します。 | データ入力 | 整数 |
Sort
指定されたセル範囲内のデータを昇順または降順で整理します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | データがソートされるワークシートの名前。 | データ入力 | 文字列 |
| CellRange | ソートされるデータを含むセルの範囲。 | データ入力 | 文字列 |
| ColumnName | データがソートされる列の名前。 ColumnName は、Excel の A から AZ までの列を表す列挙のデータ型です。 |
データ入力 | ColumnName |
| SortingOrder | データのソート順 (昇順または降順) です。 | データ入力 | SortingOrder |
VLookUp
指定したセル範囲の最初の列で特定の値を検索し、同じ行内で指定した列から対応する値を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Sheetname | 検索するワークシートの名前。 | データ入力 | 文字列 |
| SearchText | 指定した列内で検索するテキスト。 | データ入力 | 文字列 |
| LookupRange | テキストをスキャンする範囲。 | データ入力 | 文字列 |
| ApproximateMatch | これは、完全一致と近似一致のどちらを求めるかを指定する論理値です。 | データ入力 | ブーリアン |
| Return | マクロが正常に実行されたかどうかを示すブール値を返します。 | データ出力 | ブーリアン |
WrapText
Excel ワークシートの指定された行のすべてのセルでテキストの折り返しを有効にします。テキストの折り返しにより、長いテキスト文字列がセル境界内に表示され、折り返されたテキストが収まるように行の高さが自動的に調整されます。WrapText メソッドを使用すると、セルの元の幅を超えても、各セル内のすべてのテキストが完全に表示されるようにすることで、データの読みやすさを向上させることができます。これは、スプレッドシートのセル内に長いテキストエントリや複数行のコンテンツを表示する場合に特に便利です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | ソースデータが含まれているワークシートの名前。 | データ入力 | 文字列 |
| RowNumber | 指定したワークシート内で、その行内のすべてのセルにテキストの折り返しが設定されている行番号。 | データ入力 | 整数 |
WriteToRange
Data パラメーターで指定されたデータテーブルを、CellName パラメーターで指定されたセルからワークシートに書き込みます。IncludeHeaders パラメーターを設定してヘッダーを含めることもできます。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| SheetName | データが書き込まれるワークシートの名前。 | データ入力 | 文字列 |
| CellName | データが書き込まれるセルの名前。 | データ入力 | 文字列 |
| Data | 書き込まれるデータ。 | データ入力 | データテーブル |
| IncludeHeaders | データの書き込み時にヘッダーを含めるかどうかを示すブール値。デフォルト値は True に設定されています。 | データ入力 | ブーリアン |