Class: RubyOSBXL::Comments

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosbxl.rb

Overview

コメントとメモを取り扱うクラスです。

Instance Method Summary collapse

Instance Method Details

#getComment(a1) ⇒ Array<RubyOSBXL::Dto::CommentObject>

セルに紐づくコメントを取得します。

Parameters:

  • a1 (String) —

    単一セル範囲(A1)

Returns:

#getMemoAuthor(a1) ⇒ String

メモの作成者を取得します。

Parameters:

  • a1 (String) —

    単一セル範囲(A1)

Returns:

  • (String) —

    メモの作成者 メモの場合は、セル単位で一意となります。

#getMemoText(a1) ⇒ String

メモ内容を取得します。

Parameters:

  • a1 (String) —

    単一セル範囲(A1)

Returns:

  • (String) —

    メモ内容 メモの場合は、セル単位で一意となります。

#removeComment(a1) ⇒ void

セルに紐づくコメントを削除します。

Parameters:

  • a1 (String) —

    単一セル範囲(A1)

#removeMemo(a1) ⇒ void

メモを削除します。

Parameters:

  • a1 (String) —

    単一セル範囲(A1)

#setComment(a1, comment) ⇒ void

Note:

既にデータがある場合は、追加になります。その場合、親IDは、コメントの先頭データとなります。

Note:

CommentObjectのID項目は自動生成されるので、入力する必要はありません。

ワークシートにコメントを設定します。

CommentObjectのparentIdに親IDを設定すると、返信となります。親IDは、getCommentメソッドのID項目から取得できます。

Parameters:

#setCommentThread(a1, comments) ⇒ void

Note:

単一セル範囲にコメントが既にある場合は、置き換えとなります。

ワークシートにコメントをまとめて設定します。

Parameters:

#setMemo(a1, author, comment, fontObject, visible = false, rowColumnsNum = 3, colColumnsNum = 2) ⇒ void

メモを設定します。

Parameters:

  • a1 (String) —

    単一セル範囲(A1)

  • author (String) —

    メモを書く人

  • comment (String) —

    設定するメモ内容

  • fontObject (RubyOSBXL::Dto::FontObject) —

    フォントオブジェクト

  • visible (bool) (defaults to: false) —

    可視状態でメモを表示させるか true: 可視状態で表示 false: セルのクリックで可視状態とする。

  • rowColumnsNum (Integer) (defaults to: 3) —

    メモの横サイズ(何セル分表示するか)

  • colColumnsNum (Integer) (defaults to: 2) —

    メモの縦サイズ(何セル分表示するか)