ExcelScript.Comment interface

Paket:

ExcelScript

Stellt einen Kommentar in der Arbeitsmappe dar.

Methoden

addCommentReply(content, contentType)	Erstellt eine Kommentarantwort für einen Kommentar.
delete()	Löscht den Kommentar und alle verbundenen Antworten.
getAuthorEmail()	Ruft die E-Mail des Autors des Kommentars ab.
getAuthorName()	Ruft den Namen des Autors des Kommentars ab.
getCommentReply(commentReplyId)	Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist. Wenn das Kommentarantwortobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.
getContent()	Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text.
getContentType()	Ruft den Inhaltstyp des Kommentars ab.
getCreationDate()	Ruft den Erstellungszeitpunkt des Kommentars ab. Gibt zurück null , wenn der Kommentar aus einer Notiz konvertiert wurde, da der Kommentar kein Erstellungsdatum hat.
getId()	Gibt den Kommentarbezeichner an.
getLocation()	Ruft die Zelle ab, in der sich dieser Kommentar befindet.
getMentions()	Ruft die Entitäten (z. B. Personen) ab, die in Kommentaren erwähnt werden.
getReplies()	Stellt eine Sammlung der Antwortobjekte dar, die dem Kommentar zugeordnet sind.
getResolved()	Der Kommentarthread status. Der Wert bedeutet true , dass der Kommentarthread aufgelöst wird.
getRichContent()	Ruft den umfangreichen Kommentarinhalt ab (z. B. Erwähnungen in Kommentaren). Diese Zeichenfolge soll Endbenutzern nicht angezeigt werden. Ihr Add-In sollte dies nur verwenden, um umfangreiche Kommentarinhalte zu analysieren.
setContent(content)	Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text.
setResolved(resolved)	Der Kommentarthread status. Der Wert bedeutet true , dass der Kommentarthread aufgelöst wird.
updateMentions(contentWithMentions)	Updates den Kommentarinhalt mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen.

Details zur Methode

addCommentReply(content, contentType)

Erstellt eine Kommentarantwort für einen Kommentar.

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

Parameter

content

ExcelScript.CommentRichContent | string

Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder ein CommentRichContent Objekt sein (z. B. für Kommentare mit Erwähnungen).

contentType

ExcelScript.ContentType

Optional. Der Inhaltstyp, der im Kommentar enthalten ist. Der Standardwert ist enum ContentType.Plain.

Gibt zurück

ExcelScript.CommentReply

delete()

Löscht den Kommentar und alle verbundenen Antworten.

delete(): void;

Gibt zurück

void

getAuthorEmail()

Ruft die E-Mail des Autors des Kommentars ab.

getAuthorEmail(): string;

Gibt zurück

string

getAuthorName()

Ruft den Namen des Autors des Kommentars ab.

getAuthorName(): string;

Gibt zurück

string

getCommentReply(commentReplyId)

Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist. Wenn das Kommentarantwortobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getCommentReply(commentReplyId: string): CommentReply | undefined;

Parameter

commentReplyId

string

Der Bezeichner für die Kommentarantwort.

Gibt zurück

ExcelScript.CommentReply | undefined

getContent()

Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text.

getContent(): string;

Gibt zurück

string

getContentType()

Ruft den Inhaltstyp des Kommentars ab.

getContentType(): ContentType;

Gibt zurück

ExcelScript.ContentType

getCreationDate()

Ruft den Erstellungszeitpunkt des Kommentars ab. Gibt zurück null , wenn der Kommentar aus einer Notiz konvertiert wurde, da der Kommentar kein Erstellungsdatum hat.

getCreationDate(): Date;

Gibt zurück

Date

getId()

Gibt den Kommentarbezeichner an.

getId(): string;

Gibt zurück

string

getLocation()

Ruft die Zelle ab, in der sich dieser Kommentar befindet.

getLocation(): Range;

Gibt zurück

ExcelScript.Range

getMentions()

Ruft die Entitäten (z. B. Personen) ab, die in Kommentaren erwähnt werden.

getMentions(): CommentMention[];

Gibt zurück

ExcelScript.CommentMention[]

getReplies()

Stellt eine Sammlung der Antwortobjekte dar, die dem Kommentar zugeordnet sind.

getReplies(): CommentReply[];

Gibt zurück

ExcelScript.CommentReply[]

getResolved()

Der Kommentarthread status. Der Wert bedeutet true , dass der Kommentarthread aufgelöst wird.

getResolved(): boolean;

Gibt zurück

boolean

getRichContent()

Ruft den umfangreichen Kommentarinhalt ab (z. B. Erwähnungen in Kommentaren). Diese Zeichenfolge soll Endbenutzern nicht angezeigt werden. Ihr Add-In sollte dies nur verwenden, um umfangreiche Kommentarinhalte zu analysieren.

getRichContent(): string;

Gibt zurück

string

setContent(content)

Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text.

setContent(content: string): void;

Parameter

content

string

Gibt zurück

void

setResolved(resolved)

Der Kommentarthread status. Der Wert bedeutet true , dass der Kommentarthread aufgelöst wird.

setResolved(resolved: boolean): void;

Parameter

resolved

boolean

Gibt zurück

void

updateMentions(contentWithMentions)

Updates den Kommentarinhalt mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen.

updateMentions(contentWithMentions: CommentRichContent): void;

Parameter

contentWithMentions

ExcelScript.CommentRichContent

Der Inhalt des Kommentars. Diese enthält eine speziell formatierte Zeichenfolge und eine Liste von Erwähnungen, die in die Zeichenfolge analysiert werden, wenn sie von Excel angezeigt wird.

Gibt zurück

void