Microsoft Excel コネクタのメソッド

オープン

入力に応じて、既存の Microsoft ファイルを作成するか、開きます。

注:

他のメソッドの前に、このメソッドを実行する必要があります。

表 : 1. Open メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Filepath	メソッドが開く既存のファイルへのパスです。ファイルを作成するには、CreateNewFile パラメーターの値を True に設定する必要があります。注: パスにはファイル名を含める必要があります。	データ入力	文字列	なし	はい
CreateNewFile	ファイルを作成します。ファイルを作成するには、値を True に設定し、ファイルパスとファイル名を Filepath パラメーターに指定します。	データ入力	ブール	なし	いいえ
DisplayAlerts	ファイルを開いたり作成したりするときに、タスクバーにアラートを表示します。アラートを表示するには、値を True に設定した後で、IsVisible パラメーターの値を True に設定します。	データ入力	ブール	なし	いいえ
IsVisible	DisplayAlerts パラメーターと連携し、ファイルを開いたり作成したりするときにタスクバーにアラートを表示します。アラートを表示するには、値を True に設定した後で、DisplayAlerts パラメーターの値を True に設定します。	データ入力	ブール	なし	いいえ
ReadOnlyMode	値が True の場合、メソッドはファイルを読み取り専用モードで開きます。それ以外の場合は、ファイルを編集可能モードで開きます。	データ入力	ブール	なし	いいえ
パスワード	ドキュメントがパスワードで保護されている場合は、パスワードを使用します。	データ入力	文字列	なし	いいえ
戻る	値が True の場合、ファイルは開くか、作成されます。それ以外の場合、値は False です。	データ出力	ブール	適用外	適用外

AddNewWorkSheet

ファイルにワークシートを追加します。

注:

このメソッドを実行する前に、Open メソッドを実行する必要があります。

表 : 2. AddNewWorkSheet メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	メソッドがファイルに追加するワークシートの名前。	データ入力	文字列	なし	はい

GetSheetNames

開いている Microsoft Excel ドキュメント内のシートの名前を返します。

注:

このメソッドを実行する前に、Open メソッドを実行する必要があります。

表 : 3. GetSheetNames メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
戻る	開いている Microsoft Excel ドキュメント内のシートの名前を返します。	データ出力	文字列	デフォルト値なし	適用外

クローズ

アクティブな Microsoft Excel ドキュメントを閉じます。

注:

このメソッドを実行する前に、Open メソッドを実行する必要があります。

表 : 4. Close メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
saveChanges	値が True に設定されている場合、閉じる前にファイルへの変更は保存されます。False に設定されている場合、変更は保存されません。	データ入力	ブール	なし	いいえ

ColumnsCount

アクティブな Microsoft Excel ファイルのワークシート内の列の合計数を返します。

注:

このメソッドを実行する前に、Open メソッドを実行する必要があります。

表 : 5. ColumnsCount メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	メソッドが列数のカウントに使用するシートの名前。	データ入力	文字列	なし	あり
戻る	ワークシートの列数を返します。	データ出力	整数	適用外	適用外

コピー

ワークシートのセル範囲から内容をコピーします。

ヒント:

Paste メソッドを使用して、コピーした内容を貼り付けることができます。

表 : 6. Copy メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Sheetname	メソッドがセル内容をコピーする元となるシートの名前。	データ入力	文字列	なし	はい
Cellrange	メソッドが内容をコピーする元となるセル範囲。	データ入力	文字列	なし	はい

CreateChart

開いている Microsoft Excel ドキュメントに、指定されたタイプのグラフを作成します。

注:

このメソッドを実行する前に、Open メソッドを実行する必要があります。

表 : 7. CreateChart メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	グラフが作成されるシートの名前。	データ入力	文字列	デフォルト値なし	はい
CellRange	メソッドがグラフ作成用のデータを取得する元となるセル範囲。	データ入力	文字列	デフォルト値なし	はい
ChartType	作成されるグラフのタイプ。	データ入力	ExcelChartType	デフォルト値なし	はい
戻る	True の場合、グラフは正常に作成されました。False の場合、グラフの作成は失敗しました。	データ出力	ブール	デフォルト値なし	適用外

DeleteColumn

指定されたインデックスに基づいて、列を削除します。

表 : 8. DeleteColumn メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	列が削除されるシートの名前。	データ入力	文字列	デフォルト値なし	はい
ColumnIndex	メソッドが削除する列のインデックス。	データ入力	整数	デフォルト値なし	はい
戻る	列が削除されたかどうかを示すブール値を返します。True の場合、列は削除されています。False の場合、列は削除されていません。	データ出力	ブール	適用外	適用外

DeleteContentFromRange

指定されたセル範囲から内容を削除します。

表 : 9. DeleteContentFromRange メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	内容が削除されるシートの名前。	データ入力	文字列	デフォルト値なし	はい
CellRange	列の下のセル範囲。	データ入力	文字列	デフォルト値なし	はい
戻る	内容が削除されたかどうかのブール値を返します。	データ出力	ブール	適用外	適用外

DeleteEmptyColumns

内容のない列を削除します。

表 : 10. DeleteEmptyColumns メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	空の列を含むシートの名前。	データ入力	文字列	デフォルト値なし	はい

DeleteEmptyRows

指定されたワークシートから空の行を削除します。

表 : 11. DeleteEmptyColumns メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	空の行を含むシートの名前。	データ入力	文字列	デフォルト値なし	はい

DeleteRow

指定されたインデックスに基づいて、行を削除します。

表 : 12. DeleteRow メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	行が削除されるシートの名前。	データ入力	文字列	デフォルト値なし	はい
RowIndex	削除される行のインデックス。	データ入力	整数	デフォルト値なし	はい
戻る	行が削除されたかどうかを示すブール値を返します。	データ出力	ブール	適用外	適用外

DeleteWorksheet

指定されたワークシートを削除します。

表 : 13. DeleteWorksheet メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	削除されるシートの名前。	データ入力	文字列	デフォルト値なし	はい
戻る	ワークシートが削除されたかどうかを示すブール値を返します。	データ出力	ブール	適用外	適用外

ExportChartAsImages

指定されたワークシートのグラフを、指定された場所に画像としてエクスポートします。

表 : 14. ExportChartAsImages メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	グラフを含むシートの名前。	データ入力	文字列	デフォルト値なし	はい
SaveFolderpath	グラフが保存されるローカルドライブへのパス。	データ入力	文字列	デフォルト値なし	適用外

ExportToPDF

開いている Excel ドキュメントの内容を PDF にエクスポートします。

表 : 15. ExportChartAsImages メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Filepath	PDF がエクスポートされるローカルドライブへのパス。	データ入力	文字列	デフォルト値なし	はい

FindAndReplace

指定されたワークシート内でテキストを検索して置換します。

表 : 16. FindAndReplace メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	テキストが置換されるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
FindText	置換されるテキスト。	データ入力	文字列	デフォルト値なし	はい
ReplaceTo	既存のテキストを置き換えるテキスト。	データ入力	文字列	デフォルト値なし	はい
戻る	テキストが置換されたかどうかを示すブール値を返します。	データ出力	ブール	適用外	適用外

GetActiveSheetName

アクティブなワークシートの名前を返します。

表 : 17. GetActiveSheetName メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
戻る	アクティブなワークシートの名前を返します。	データ出力	文字列	デフォルト値なし	適用外

InsertNewColumn

ワークシートの指定されたインデックスに新しい列を挿入します。

表 : 18. InsertNewColumn メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	列が挿入されるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
ColumnIndex	新しい列のインデックスです。指定されたインデックスに新しい列が挿入されます。	データ入力	整数	デフォルト値なし	はい

InsertNewRow

指定されたワークシートの指定されたインデックスに新しい行を挿入します。

表 : 19. InsertNewRow メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	行が挿入されるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
RowIndex	行のインデックスです。行は指定されたインデックスに挿入されます。	データ入力	整数	デフォルト値なし	はい
戻る	行が挿入されたかどうかを示すブール値を返します。True の場合、行は挿入されました。False の場合、行は挿入されませんでした。	データ出力	ブール	適用外	適用外

InsertObject

Excel ファイルのシートの指定されたセルにオブジェクトを挿入します。オブジェクトの例としては、Excel ファイル、画像、PDF ファイルなどがあります。

注:

このメソッドを実行する前に、Open メソッドを実行します。

表 : 20. InsertObject メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	メソッドがオブジェクトを挿入するセルを含む Excel シート。	データ入力	文字列	NA	はい
CellName	メソッドがオブジェクトを挿入するセルの名前。たとえば、A1 などです。	データ入力	文字列	NA	はい
Filepath	メソッドが挿入するオブジェクトのファイルパス。	データ入力	文字列	NA	はい

IsOpen

指定された Excel ファイルが開いているかどうかを示すブール値を返します。

表 : 21. IsOpen メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Filepath	ローカルドライブ内の Excel ファイルへのパス。	データ入力	文字列	デフォルト値なし	はい
戻る	Excel ファイルが開いているかどうかを示すブール値を返します。	データ出力	ブール	適用外	適用外

MergeCells

範囲内で指定されたセルを結合します。

表 : 22. MergeCells メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Sheetname	セルが結合されるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
CellRange	セルの範囲です。範囲内のすべてのセルが結合されます。	データ入力	文字列	デフォルト値なし	はい

ReadFromRange

指定されたワークシートからデータを読み取り、そのデータを返します。

表 : 23. ReadFromRange メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	メソッドがデータを読み取る元となるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
CellRange	セルの範囲です。メソッドはこれらのセルからデータを読み取ります。	データ入力	文字列	デフォルト値なし	はい
FirstRowAsHeader	メソッドが最初の行をヘッダーとして扱うかどうかを示すブール値です。True の場合、最初の行はヘッダーとして扱われます。False の場合、最初の行はヘッダーとして扱われません。	データ入力	ブール	デフォルト値なし	いいえ
戻る	セルのデータで構成されるデータテーブルを返します。	データ出力	データテーブル	適用外	いいえ

ReadFromSheet

指定されたワークシート内のすべてのデータを返します。

表 : 24. MergeCells メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Sheetname	メソッドがデータを読み取る元となるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
戻る	指定されたワークシート内のすべてのデータを返します。	データ出力	DataTable	適用外	適用外

RenameSheetName

既存のワークシートの名前を変更します。

表 : 25. RenameSheetName メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
OldSheetName	既存のワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
NewSheetName	ワークシートの新しい名前。	データ入力	文字列	デフォルト値なし	はい
戻る	ワークシートの名前が変更されたかどうかを示すブール応答を返します。	データ出力	ブール	デフォルト値なし	適用外

RowsCount

指定されたワークシート内の行数を返します。

表 : 26. RenameSheetName メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	行数を返す元となるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
戻る	行数を返します。	データ出力	整数	適用外	適用外

RemoveFilter

Excel ドキュメントに設定されているすべてのフィルターを削除します。

表 : 27. RemoveFilter メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
Sheetname	メソッドがフィルターを削除するワークシートの名前。	データ入力	文字列	デフォルト値なし	はい

保存

Excel ドキュメントへの変更を保存します。

WriteToRange

指定された範囲にデータを書き込みます。

表 : 28. RemoveFilter メソッドのパラメーター
パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
SheetName	データが書き込まれるワークシートの名前。	データ入力	文字列	デフォルト値なし	はい
CellName	データが書き込まれるセルの名前。	データ入力	文字列	デフォルト値なし	はい
データ	書き込まれるデータ。	データ入力	データテーブル	デフォルト値なし	はい
IncludeHeaders	データテーブルのヘッダーを追加するかどうかを示すブール値。	データ入力	ブール	デフォルト値なし	いいえ