pyosbxl.dto.CommentObject

class documentation

class CommentObject:

Excelの新形式コメントを扱うオブジェクトです。(旧型式のオブジェクトは、Excelに合わせ、メモと呼びます)。

Method	`__init__`	コンストラクタ。インスタンスを作成します。
Method	`getAuthor`	コメント者を取得します。
Method	`getCommentDate`	コメント日時を取得します。
Method	`getContent`	コメントを取得します。
Method	`getDone`	スレッドの完了フラグを取得します。
Method	`getId`	コメントのスレッドIDを取得します。
Method	`getParentId`	コメントの親スレッドIDを取得します。トップ階層の場合は、空文字となります。
Method	`setAuthor`	コメント者を設定します。
Method	`setCommentDate`	コメント日時に日付時刻オブジェクトを適用します。
Method	`setContent`	コメントを設定します。
Method	`setDone`	スレッドの完了フラグを立てます。
Method	`setParentId`	親コメントIDを設定します。コメントに返信する場合、親オブジェクトのスレッドIDを設定します。

def __init__(self): ¶

コンストラクタ。インスタンスを作成します。

def getAuthor(self) -> str: ¶

コメント者を取得します。

Returns
`str`	コメント者

def getCommentDate(self) -> DateTimeObject: ¶

コメント日時を取得します。

Returns
`DateTimeObject`	コメント日時

def getContent(self) -> str: ¶

コメントを取得します。

Returns
`str`	コメント

def getDone(self) -> bool: ¶

スレッドの完了フラグを取得します。

Returns
`bool`	true: スレッドが完了している false: スレッドが完了していない

def getId(self) -> str: ¶

コメントのスレッドIDを取得します。

Returns
`str`	コメントのスレッドID

def getParentId(self) -> str: ¶

コメントの親スレッドIDを取得します。トップ階層の場合は、空文字となります。

Returns
`str`	コメントの親スレッドID

def setAuthor(self, author: str): ¶

コメント者を設定します。

Parameters
author:`str`	コメント者

def setCommentDate(self, dt: DateTimeObject): ¶

コメント日時に日付時刻オブジェクトを適用します。

Parameters
dt:`DateTimeObject`	コメント日時

def setContent(self, content: str): ¶

コメントを設定します。

Parameters
content:`str`	コメント

def setDone(self, done: bool): ¶

スレッドの完了フラグを立てます。

Parameters
done:`bool`	true: 完了 false:完了していない

def setParentId(self, parentId: str): ¶

親コメントIDを設定します。コメントに返信する場合、親オブジェクトのスレッドIDを設定します。

Parameters
parentId:`str`	親コメントID