ExcelScript.Comment interface

パッケージ:

ExcelScript

ブック内のコメントを表します。

メソッド

addCommentReply(content, contentType)	コメントのコメント応答を作成します。
delete()	コメントと接続されているすべての応答を削除します。
getAuthorEmail()	コメント作成者のメール アドレスを取得します。
getAuthorName()	コメント作成者の名前を取得します。
getCommentReply(commentReplyId)	その ID で識別されるコメント返信を返します。 コメント応答オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getContent()	コメントの内容。 文字列はプレーン テキストです。
getContentType()	コメントのコンテンツ タイプを取得します。
getCreationDate()	コメントの作成日時を取得します。 コメントの作成日がないため、コメントがノートから変換された場合は、 null を返します。
getId()	コメント識別子を指定します。
getLocation()	このコメントが配置されているセルを取得します。
getMentions()	コメントに記載されているエンティティ (people など) を取得します。
getReplies()	コメントに関連付けられている返信オブジェクトのコレクションを表します。
getResolved()	コメント スレッドの状態。 true の値は、コメント スレッドが解決されることを意味します。
getRichContent()	リッチ コメント コンテンツ (コメント内のメンションなど) を取得します。 この文字列は、エンド ユーザーに表示されるものではありません。 アドインでは、これを使用してリッチ コメント コンテンツを解析する必要があります。
setContent(content)	コメントの内容。 文字列はプレーン テキストです。
setResolved(resolved)	コメント スレッドの状態。 true の値は、コメント スレッドが解決されることを意味します。
updateMentions(contentWithMentions)	特別な形式の文字列とメンションのリストを含むコメント コンテンツをUpdatesします。

メソッドの詳細

addCommentReply(content, contentType)

コメントのコメント応答を作成します。

addCommentReply(
            content: CommentRichContent | string,
            contentType?: ContentType
        ): CommentReply;

パラメーター

content

ExcelScript.CommentRichContent | string

コメントの内容。 これは、文字列または CommentRichContent オブジェクト (メンションを含むコメントの場合など) のいずれかです。

contentType

ExcelScript.ContentType

省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plainです。

戻り値

ExcelScript.CommentReply

delete()

コメントと接続されているすべての応答を削除します。

delete(): void;

戻り値

void

getAuthorEmail()

コメント作成者のメール アドレスを取得します。

getAuthorEmail(): string;

戻り値

string

getAuthorName()

コメント作成者の名前を取得します。

getAuthorName(): string;

戻り値

string

getCommentReply(commentReplyId)

その ID で識別されるコメント返信を返します。 コメント応答オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getCommentReply(commentReplyId: string): CommentReply | undefined;

パラメーター

commentReplyId

string

コメント応答の識別子。

戻り値

ExcelScript.CommentReply | undefined

getContent()

コメントの内容。 文字列はプレーン テキストです。

getContent(): string;

戻り値

string

getContentType()

コメントのコンテンツ タイプを取得します。

getContentType(): ContentType;

戻り値

ExcelScript.ContentType

getCreationDate()

コメントの作成日時を取得します。 コメントの作成日がないため、コメントがノートから変換された場合は、 null を返します。

getCreationDate(): Date;

戻り値

Date

getId()

コメント識別子を指定します。

getId(): string;

戻り値

string

getLocation()

このコメントが配置されているセルを取得します。

getLocation(): Range;

戻り値

ExcelScript.Range

getMentions()

コメントに記載されているエンティティ (people など) を取得します。

getMentions(): CommentMention[];

戻り値

ExcelScript.CommentMention[]

getReplies()

コメントに関連付けられている返信オブジェクトのコレクションを表します。

getReplies(): CommentReply[];

戻り値

ExcelScript.CommentReply[]

getResolved()

コメント スレッドの状態。 true の値は、コメント スレッドが解決されることを意味します。

getResolved(): boolean;

戻り値

boolean

getRichContent()

リッチ コメント コンテンツ (コメント内のメンションなど) を取得します。 この文字列は、エンド ユーザーに表示されるものではありません。 アドインでは、これを使用してリッチ コメント コンテンツを解析する必要があります。

getRichContent(): string;

戻り値

string

setContent(content)

コメントの内容。 文字列はプレーン テキストです。

setContent(content: string): void;

パラメーター

content

string

戻り値

void

setResolved(resolved)

コメント スレッドの状態。 true の値は、コメント スレッドが解決されることを意味します。

setResolved(resolved: boolean): void;

パラメーター

resolved

boolean

戻り値

void

updateMentions(contentWithMentions)

特別な形式の文字列とメンションのリストを含むコメント コンテンツをUpdatesします。

updateMentions(contentWithMentions: CommentRichContent): void;

パラメーター

contentWithMentions

ExcelScript.CommentRichContent

コメントの内容。 これには、特別に書式設定された文字列と、Excel で表示されるときに文字列に解析されるメンションの一覧が含まれます。

戻り値

void