Class Comments

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

Index

Methods

getComment getMemoAuthor getMemoText removeComment removeMemo setComment setCommentThread setMemo

Methods

getComment

getComment(A1): CommentObject[]
セルに紐づくコメントを取得します。
Parameters
- A1: string
  単一セル範囲(A1)
Returns CommentObject[]
Array<コメントオブジェクト>

getMemoAuthor

getMemoAuthor(A1): string
メモの作成者を取得します。
Parameters
- A1: string
  単一セル範囲(A1)
Returns string
メモの作成者メモの場合は、セル単位で一意となります。

getMemoText

getMemoText(A1): string
メモ内容を取得します。
Parameters
- A1: string
  単一セル範囲(A1)
Returns string
メモ内容メモの場合は、セル単位で一意となります。

removeComment

removeComment(A1): void
セルに紐づくコメントを削除します。
Parameters
- A1: string
  単一セル範囲(A1)
Returns void

removeMemo

removeMemo(A1): void
メモを削除します。
Parameters
- A1: string
  単一セル範囲(A1)
Returns void

setComment

setComment(A1, comment): void
ワークシートにコメントを設定します。
Parameters
- A1: string
  単一セル範囲(A1)
- comment: CommentObject
  コメントオブジェクト
  1. 既にデータがある場合は、追加になります。その場合、親IDは、コメントの先頭データとなります。
  2. CommentObjectのID項目は自動生成されるので、入力する必要はありません。
  3. CommentObjectのparentIdに親IDを設定すると、返信となります。親IDは、getCommentメソッドのID項目から取得できます。
Returns void

setCommentThread

setCommentThread(A1, comments): void
ワークシートにコメントをまとめて設定します。
Parameters
- A1: string
  単一セル範囲(A1)
- comments: CommentObject[]
  Array<コメントオブジェクト>
  1. 単一セル範囲にコメントが既にある場合は、置き換えとなります。
Returns void

setMemo

setMemo(A1, author, comment, fontObject, visible?, rowColumnsNum?, colColumnsNum?): void
メモを設定します。
Parameters
- A1: string
  単一セル範囲(A1)
- author: string
  メモを書く人
- comment: string
  設定するメモ内容
- fontObject: FontObject
  フォントオブジェクト
- visible: boolean = false
  可視状態でメモを表示させるか true: 可視状態で表示 false: セルのクリックで可視状態とする。
- rowColumnsNum: number = 3
  メモの横サイズ(何セル分表示するか)
- colColumnsNum: number = 2
  メモの縦サイズ(何セル分表示するか)
Returns void

Copyright © 2023. OSB-OFFICE.Inc, All rights reserved. Generated using TypeDoc