こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。
この記事では、 RubyのrubyXLのgemを使ってエクセルファイル(xlsx)にシート名を指定するやり方について、
- エクセルファイル(xlsx)にシート名を指定するサンプルプログラム
- 実行結果
- 解説
という順番で解説していきます。
rubyXLをインストールするやり方はこちらの記事をご参考ください。
前提条件:実行環境について
実行環境は以下の通りです。
OS | Windows10 |
---|---|
Rubyのバージョン | 2.6.6 |
rubyXLのバージョン | 3.4.25 |
この記事ではRubyプログラムは
C:\rubystudy
に作成しています。
エクセルファイル(xlsx)にシート名を指定するサンプルプログラム
このサンプルプログラムは、
C:\rubystudy\sample\aaa
配下にある「sample.xlsx」というエクセルファイルにシート名を指定します。
1 2 3 4 5 6 7 8 9 10 |
require 'rubyXL' sample_xlsx = RubyXL::Workbook.new sample_worksheet = sample_xlsx[0] sample_worksheet.sheet_name = 'シート名テスト' sample_xlsx.write('C:/rubystudy/sample/aaa/sample.xlsx') puts "xlsx書き込み完了" |
実行結果
実行前に
C:\rubystudy\sample\aaa
の「sample.xlsx」の中を確認します。
シート名は「Sheet1」であることを確認しました。
では、エクセルファイルがに書き込みできるかを確認します。
Rubyプログラムを実行するやり方は、以下の記事をご参考ください。
1 2 |
C:\rubystudy>ruby workbook_font_bold_sample.rb xlsx書き込み完了 |
C:\rubystudy\sample\aaa
の「sample.xlsx」の中を確認します。
シート名が指定できていることが確認できました。
解説
サンプルプログラムから大切な点である
- requireについて
- シート名指定ついて
の2点を解説していきます。
requireについて
rubyXLを使う場合
1 |
require 'rubyXL' |
は必須の宣言です。
忘れないようご注意ください。
require関数については、こちらの記事をご参考ください。
シート名指定ついて
エクセルファイルのシート名を指定している箇所は
1 2 |
sample_worksheet = sample_xlsx[0] sample_worksheet.sheet_name = 'シート名テスト' |
の部分です。
1 |
sample_worksheet = sample_xlsx[0] |
では作成したWorkbookの最初のシートを取得しています。
取得したシートに対して、sheet_nameメソッドでシート名を指定しています。
1 |
sample_worksheet.sheet_name = 'シート名テスト' |
sheet_nameメソッドを使うときの注意点として、Excelの仕様で31文字までしか指定できません。
まとめ:rubyXLでエクセルファイル(xlsx)のシート名を指定してみよう
以上がRubyでrubyXLを使ってエクセルファイル(xlsx)のシート名を指定するやり方の解説でした!
あなたのご参考になったのなら、とても嬉しいです(*´▽`*)
ではでは~(・ω・)ノシ
コメント