xbot.excel.WorkSheet
この記事の内容
- メソッド
- get_cell()
- get_row()
- get_column()
- get_range()
- set_cell()
- set_row()
- set_column()
- set_range()
- append_row()
- insert_row()
- remove_row()
- remove_column()
- clear()
- get_row_count()
- get_column_count()
- select_range()
- get_name()
- insert_column()
- get_first_free_column()
- get_first_free_column_on_row()
- get_first_free_row()
- get_first_free_row_on_column()
- copy_range()
- paste_range()
- paste_range_ex()
- clear_range()
- set_row_hidden()
- set_column_hidden()
Excelの内容の取得、書き込み、クリアなど、ワークシートオブジェクトを操作します。
メソッド
get_cell()
ワークシート内の指定したセルの内容を取得します。
get_cell(self, row_num, col_name)
入力パラメータ
row_num:指定するセルの行番号です。行番号は 1 から始まります。
col_name:指定するセルの列名です。列名は'A'から始まります。
戻り値
any:ワークシート内の指定したセルの内容を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
data = worksheet.get_cell(10, 'B')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内の 10 行目、B 列のセルの内容を取得します。
get_row()
ワークシート内の指定した行の内容を取得します。
get_row(self, row_num)
入力パラメータ
row_num:指定する行番号です。行番号は1から始まります。
戻り値
List[any]:読み取った内容のリストを返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
data = worksheet.get_row(1)
print(data)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内の1行目の内容を取得します --> 取得した内容を出力します。
get_column()
ワークシート内の指定した列の内容を取得します。
get_column(self, col_name)
入力パラメータ
col_name:指定する列名です。列名は'A'から始まります。
戻り値
List[any]:読み取った内容のリストを返します。例:['a', 'b', 'c', 'd']
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
data = worksheet.get_column('A')
print(data)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内の 'A' 列の内容を取得します --> 取得した内容を出力します。
get_range()
ワークシート内の指定した範囲の内容を取得します。
get_range(self, begin_row_num, begin_column_name, end_row_num, end_column_name)
入力パラメータ
begin_row_num:開始セルの行番号です。行番号は1から始まります。
begin_column_name:開始セルの列名です。列名はAから始まります。
end_row_num:終了セルの行番号です。行番号は1から始まります。
end_column_name:終了セルの列名です。列名はAから始まります。
戻り値
List[Tuple]:読み取った2次元リストを返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
data = worksheet.get_range(1, 'A', 3, 'F')
print(data)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内の開始セル A1 から終了セル F3 までの矩形範囲の内容を取得します --> 取得した内容を出力します。
set_cell()
ワークシート内の指定したセルに内容を書き込みます。
set_cell(self, row_num, col_name, value)
入力パラメータ
row_num:指定するセルの行番号です。
col_name:指定するセルの列名です。
value:セルに書き込む内容です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.set_cell(10, 'B', 'hello world')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの 10 行目、B 列のセルに 'hello world' を書き込みます。
set_row()
ワークシートの行の内容を設定します。
set_row(self, row_num, values, begin_column_name = 'A')
入力パラメータ
row_num:内容を書き込む行番号を指定します。行番号は 1 から始まります。
values:書き込む内容です。リスト型である必要があります。
begin_column_name:内容の書き込みを開始する列名を指定します。デフォルト値は 'A' です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.set_row(1, ['a', 1, 2], begin_column_name = 'A')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 1 行目、A 列に ['a', 1, 2] を書き込みます。
set_column()
ワークシートに列の内容を書き込みます。
set_column(selef, col_name, values, begin_row_num = 1)
入力パラメータ
col_name:内容を書き込む列名を指定します。
values:書き込む内容です。リスト型である必要があります。
begin_row_num:内容の書き込みを開始する行番号を指定します。デフォルト値は 1 です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.set_column('A', [1,2,3,4,5,6,7,8,9,0], begin_row_num = 1)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 1 行目から、A 列のデータ値を [1,2,3,4,5,6,7,8,9,0] に設定します。
set_range()
ワークシート内の指定した範囲に内容を書き込みます。
set_range(self, row_num, col_name, values)
入力パラメータ
row_num:書き込み範囲の開始行番号です。行番号は1から始まります。
col_name:書き込み範囲の開始列名です。列名はAから始まります。
values:書き込む内容です。2次元配列である必要があります。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.set_range(1, 'A', [['1','2','3'],['a','b','c']])
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> A1 から内容 [['1','2','3'],['a','b','c']] を書き込みます。
append_row()
ワークシートの末尾に1行分の内容を追加します。
append_row(self, values, begin_column_name = 'A')
入力パラメータ
values:書き込む値です。リスト型である必要があります。
begin_column_name:開始セルの列名を設定します。デフォルト値は A です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.append_row([1,2,3,4,5,6,7,8,9,0], begin_column_name = 'B')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの末尾に1行分の内容を追加します。書き込みを開始するセルの列名は B、内容は [1,2,3,4,5,6,7,8,9,0] です。
insert_row()
ワークシートに1行分の内容を挿入します。
insert_row(self, row_num, values, begin_column_name = 'A')
入力パラメータ
row_num:挿入位置の行番号です。行番号は1から始まります。
values:挿入する値です。リスト型である必要があります。
begin_column_name:内容の挿入を開始する列名です。デフォルト値は A です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.insert_row(10, [1,2,3,4,5,6,7,8,9,0], begin_column_name = 'A')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの 10 行目にレコードを1件挿入します。行の開始セルの列名は A、挿入する値は [1,2,3,4,5,6,7,8,9,0] です。
remove_row()
ワークシートの特定の行の内容を削除します。
remove_row(self, row_num)
入力パラメータ
row_num:削除する行番号です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.remove_row(10)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内の 10 行目のデータを削除します。
remove_column()
ワークシートの特定の列の内容を削除します。
remove_column(self, column_name)
入力パラメータ
column_name:削除する列名です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.remove_column('D')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内の D 列のデータを削除します。
clear()
ワークシートの内容をクリアします。
clear(self)
入力パラメータ
なし
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
worksheet.clear()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの内容をクリアします。
get_row_count()
ワークシートの総行数を取得します。
get_row_count(self)
入力パラメータ
なし
戻り値
int:ワークシートの総行数を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_row_count()
print(count)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの現在のデータの総行数を取得します --> 総行数を出力します。
get_column_count()
ワークシートの総列数を取得します。
get_column_count(self)
入力パラメータ
なし
戻り値
int:ワークシートの総列数を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_column_count()
print(count)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの現在のデータの総列数を取得します --> 総列数を出力します。
select_range()
ワークシート内の指定した内容の範囲を選択します。
select_range(self, begin_row_num, begin_column_name, end_row_num, end_column_name)
入力パラメータ
begin_row_num:開始セルの行番号です。行番号は1から始まります。
begin_column_name:開始セルの列名です。列名はAから始まります。
end_row_num:終了セルの行番号です。行番号は1から始まります。
end_column_name:終了セルの列名です。列名はAから始まります。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.select_range(1, 'A', 3, 'C')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内のセル A1 からセル C3 までの矩形範囲の内容を選択します。
get_name()
ワークシートの名称を取得します。
get_name(self)
入力パラメータ
なし
戻り値
str:ワークシートの名称を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_name()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシートの現在のデータの名称を取得します。
insert_column()
列を挿入します。
select_range(self, column_name, values, begin_row_index = 1)
入力パラメータ
column_name:データの挿入を開始する列名です。
values:挿入するデータです。
begin_row_index:挿入を開始する行番号です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.insert('D', [1, 'a', 2], 3)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 3行目から、リスト [1, 'a', 2] を D 列に挿入します。
get_first_free_column()
最初の使用可能な列を取得します。
get_first_free_column(self)
入力パラメータ
なし
戻り値
str:ワークシートの列名を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_first_free_column()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 現在のリストの最初の使用可能な列を取得します。
get_first_free_column_on_row()
行内の最初の使用可能な列を取得します。
get_first_free_column_on_row(self, row_num)
入力パラメータ
row_num:行番号です。
戻り値
str:ワークシートの列名を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_first_free_column_on_row(3)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 現在のリストの3行目にある最初の使用可能な列を取得します。
get_first_free_row()
最初の使用可能な行を取得します。
get_first_free_row(self)
入力パラメータ
なし
戻り値
int:ワークシートの行番号を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_first_free_row()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 現在のリストの最初の使用可能な行を取得します。
get_first_free_row_on_column()
列内の最初の使用可能な行を取得します。
get_first_free_row_on_column(self, column_name)
入力パラメータ
column_name:列名です。
戻り値
int:ワークシートの行番号を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.get_first_free_row_on_column('D')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 現在のリストの D 列にある最初の使用可能な行を取得します。
copy_range()
指定した範囲の内容をクリップボードにコピーします。
copy_range(self, begin_row_num, begin_column_name, end_row_num, end_column_name)
入力パラメータ
begin_row_num:開始セルの行番号です。行番号は1から始まります。
begin_column_name:開始セルの列名です。列名はAから始まります。
end_row_num:終了セルの行番号です。行番号は1から始まります。
end_column_name:終了セルの列名です。列名はAから始まります。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.copy_range(1, 'A', 3, 'C')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内のセル A1 からセル C3 までの矩形範囲の内容をコピーします。
paste_range()
指定した開始セルからクリップボードのデータを貼り付けます(このインターフェースは非推奨となっており、今後は保守されません。インターフェースpaste_range_exの使用を推奨します)。
paste_range(self, row_num, column_name)
入力パラメータ
row_num:開始セルの行番号です。行番号は1から始まります。
column_name:開始セルの列名です。列名はAから始まります。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.paste_range(3, 'C')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 指定した開始セル C3 からクリップボードのデータを貼り付けます。
paste_range_ex()
指定した開始セルからクリップボードのデータを貼り付けます。貼り付け形式の機能を拡張しています。
paste_range_ex(self, row_num, column_name, paste_type, paste_special_operation, skip_blanks, transpose)
入力パラメータ
row_num:開始セルの行番号です。行番号は1から始まります。
column_name:開始セルの列名です。列名はAから始まります。
paste_type:貼り付けタイプです。タイプのパラメータコードは次のとおりです。
| 貼り付けタイプ | パラメータコード |
|---|---|
| すべて | -4104 |
| 数式 | -4123 |
| 数値 | -4163 |
| 書式 | -4122 |
| コメントのみ | -4144 |
| 入力規則のみ | 6 |
| コピー元のテーマを維持 | 13 |
| 罫線以外 | 7 |
| 列幅 | 8 |
| 数式と数値書式 | 11 |
| 値と数値書式 | 12 |
paste_special_operation:演算です。パラメータコードは次のとおりです。
| 貼り付けタイプ | パラメータコード |
|---|---|
| なし | -4142 |
| 加算 | 2 |
| 減算 | 3 |
| 乗算 | 4 |
| 除算 | 5 |
skip_blanks:空セルをスキップするかどうかを指定します。デフォルトはFalse(スキップしない)です。
transpose:行と列を入れ替えて貼付するかどうかを指定します。デフォルトはFalse(行と列を入れ替えない)です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.paste_range(3, 'C', -4104, -4142, False, False)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 指定した開始セル C3 からクリップボードのデータを貼り付けます。貼り付けタイプは「すべて」です。
clear_range()
指定した範囲の内容をクリアします。
clear_range(self, begin_row_num, begin_column_name, end_row_num, end_column_name)
入力パラメータ
begin_row_num:開始セルの行番号です。行番号は1から始まります。
begin_column_name:開始セルの列名です。列名はAから始まります。
end_row_num:終了セルの行番号です。行番号は1から始まります。
end_column_name:終了セルの列名です。列名はAから始まります。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
count = worksheet.clear_range(1, 'A', 3, 'C')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ワークシート内のセル A1 からセル C3 までの矩形範囲の内容をクリアします。
set_row_hidden()
行の非表示属性を設定します。
set_row_hidden(self, row_num, hidden = False)
入力パラメータ
row_num:行番号です。型はlistで、行番号は1から始まります。
hidden:非表示属性です。デフォルトはFalse(表示)です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
row_list = [1,2,3]
worksheet.set_row_hidden(row_list, True)
workbook.save()
workbook.close()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 1行目から3行目までを非表示に設定します。
set_column_hidden()
列の非表示属性を設定します。
set_column_hidden(self, column_name, hidden = False)
入力パラメータ
column_name:列名のリストです。列名はAから始まります。
hidden:非表示属性です。デフォルトはFalse(表示)です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
col_list = ['A','B','C']
worksheet.set_column_hidden(col_list, True)
workbook.save()
workbook.close()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます -->A列からC列までを非表示に設定します --> Excelシートを保存します --> Excelシートを閉じます。