wrdap.rbで定義されているメソッド

最終更新日: 2016/03/01

 wrdap.rbは、ruby経由でMS-Wordを自動操縦するためのruby用ライブラリです。

 その中には次の3種類のクラスとモジュールがあり、それぞれ各種メソッドが定義されています。

  1. class Wrdap: Word Applicationを扱うためのクラス
  2. class Wrdoc: ワードのドキュメントを扱うためのクラス
  3. module Wrd: 共通に用いるメソッド

 以下、各々のメソッドの仕様について記します。


《目次》


1. class Wrdap

 Word Applicationを扱うためのクラス

 VBAにおける Word.Application に相当。

(1) Wrdap.new(file1, file2, ……)

(2) quit()

(3) opens(file1, file2, ……)

(4) opens_once(file1, file2, ……)

(5) doc_open(param)

(6) doc_close(doc)

(7) doc_names()

(8) display_alert(val)

(9) each

(10) ltpl_info(type = :string)

目次に戻る


(11) macro_add(str, type=nil, name=nil)

(12) macro_code(type=nil, name=nil)

(13) macro_export(type=nil, name=nil, opt=nil)

(14) macro_import(filename, dup_check=false)

(15) macro_list(type=nil, name=nil)

(16) macro_list2(type=nil, name=nil)

(17) macro_name(type=nil, name=nil)

(18) macro_remove(type=nil, name=nil)

(19) macro_run(mname, arg1, arg2, ……)

(20) version

(21) クラス変数 auto_close, auto_quit など

 Wrdapには次のようなクラス変数がある。

 「wrd = Wrdap.new」とした場合、wrd.auto_quit のようにして値を参照できる。

目次に戻る


2. class Wrdoc

 ワードのドキュメント(1つのワード文書)を扱うためのクラス。

 VBAにおける ActiveDocument に相当。

 このWrdocオブジェクトは、先述の Wrdap.doc_open() によって生成される。ユーザーが自作スクリプト内で Wrdoc.new と記述することは、あまりないと思う。

(1) close()

(2) save(save_name)

(3) name()

(4) page_setup(page_info, *sect) / 別名ps()

(5) page_setup_info(*sect) / 別名 psi()

(6) last_page_info() / 別名 lpi()

(7) paragraph_adjust(adjust_str) / 別名 pa()

(8) check_page_number(*sect) / 別名 cpn()

(9) del_page_number(*sect) / 別名 dpn()

(10) add_page_number(*sect) / 別名 apn()

(11) std_font(jfont, afont, size) / 別名 sf()

(12) get_info(sect_num)

(13) set_info(arg, sect_num)

目次に戻る


(14) table_border(style, outside_style, outside_width, *tbl_nums)

(15) table_row(align_str, *tbl_nums)

(16) table_col(align_str, *tbl_nums)

(17) table_ary(*tbl_nums)

(18) table_para(*tbl_nums)

(19) table_center(*tbl_nums)

(20) ltpl_info(type = :string)

目次に戻る


(21) macro_add(str, type=nil, name=nil)

(22) macro_code(type=nil, name=nil)

(23) macro_export(type=nil, name=nil, opt=nil)

(24) macro_import(filename, dup_check=false)

(25) macro_list(type=nil, name=nil)

(26) macro_list2(type=nil, name=nil)

(27) macro_name(type=nil, name=nil)

(28) macro_remove(type=nil, name=nil)

(29) macro_run(mname, arg1, arg2, ……)

(30) pdf_out(arg = {})

(31) クラス変数 app, obj

 Wrdocには次のようなクラス変数がある。

 「wrd=Wrdap.new; doc=wrd.doc_open(“test.doc”)」とした場合、doc.app のようにして値を参照できる。

目次に戻る


3. module Wrd

 共通に用いるメソッド。

 markdownの原稿からワード文書を生成するためのpandocコマンドに関連するメソッドなどが含まれる。

 メソッド名に pandoc が付いているものを利用する場合は、予め pandoc.exe および rubyライブラリのpandoc-rubyをインストールしておく必要がある。pandoc-rubyは gem でインストール可能。

(1) fullpath(fname)

(2) filename2(fname)

(3) filename3(fname)

(4) wd_load()

(5) time2str(x)

(6) to_num(x)

(7) str2ary(str, sep, atype)

(8) ary2str(aa, sep)

(9) set_pandoc_path()

(10) pandoc_convert(str, *opt)

(11) pandoc_docx(str, *opt)

(12) pandoc_html(str, *opt)

(13) pandoc_tex(str, *opt)

(14) erb_three(str)

(15) matrix2table(data, *arg) / 別名 pipe_table()

(16) text_table(ary, header, sep) / 別名 ascii_table()

(17) ltpl_info(tpls, type = :string)

(18) commento_info(str)

(19) info()

(20) mkd2docx(mkd_str, out_file)

〜 以上 〜

Copyright (C) T. Yoshiizumi, 2013-2014 All rights reserved.


wrdapの解説ページへ

wrdapの修正履歴

トップページへ