pyosbxl.Comments

class documentation

class Comments:

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

Method	`getComment`	セルに紐づくコメントを取得します。
Method	`getMemoAuthor`	メモの作成者を取得します。
Method	`getMemoText`	メモ内容を取得します。
Method	`removeComment`	セルに紐づくコメントを削除します。
Method	`removeMemo`	メモを削除します。
Method	`setComment`	ワークシートにコメントを設定します。
Method	`setCommentThread`	ワークシートにコメントをまとめて設定します。
Method	`setMemo`	メモを設定します。

def getComment(self, A1: str) -> dto.VectorCommentObject: ¶

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

Parameters
A1:`str`	単一セル範囲(A1)
Returns
`VectorCommentObject`	List＜コメントオブジェクト＞

def getMemoAuthor(self, A1: str) -> str: ¶

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

Parameters
A1:`str`	単一セル範囲(A1)
Returns
`str`	メモの作成者メモの場合は、セル単位で一意となります。

def getMemoText(self, A1: str) -> str: ¶

メモ内容を取得します。

Parameters
A1:`str`	単一セル範囲(A1)
Returns
`str`	メモの作成者メモの場合は、セル単位で一意となります。

def removeComment(self, A1: str): ¶

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

Parameters
A1:`str`	単一セル範囲(A1)

def removeMemo(self, A1: str): ¶

メモを削除します。

Parameters
A1:`str`	単一セル範囲(A1)

def setComment(self, A1: str, comment: dto.CommentObject): ¶

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

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

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

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

Parameters
A1:`str`	単一セル範囲(A1)
comment:`CommentObject`	コメントオブジェクト

def setCommentThread(self, A1: str, comments: dto.VectorCommentObject): ¶

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

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

Parameters
A1:`str`	単一セル範囲(A1)
comments:`VectorCommentObject`	List＜コメントオブジェクト＞

def setMemo(self, A1: str, author: str, comment: str, fontObject: dto.FontObject, visible: bool = False, rowColumnsNum: int = 3, colColumnsNum: int = 2): ¶

メモを設定します。

Parameters
A1:`str`	単一セル範囲(A1)
author:`str`	メモを書く人
comment:`str`	設定するメモ内容
fontObject:`FontObject`	フォントオブジェクト
visible:`bool`, optional	可視状態でメモを表示させるか true: 可視状態で表示 false: セルのクリックで可視状態とする。
rowColumnsNum:`int`, optional	メモの横サイズ(何セル分表示するか)
colColumnsNum:`int`, optional	メモの縦サイズ(何セル分表示するか)