Excel.CommentReply class
Stellt eine Kommentarantwort in der Arbeitsmappe dar.
- Extends
Hinweise
Verwendet von
Eigenschaften
| author |
Ruft die E-Mail des Autors der Kommentarantwort ab. |
| author |
Ruft den Namen des Autors der Kommentarantwort ab. |
| content | Der Inhalt der Kommentarantwort. Bei der Zeichenfolge handelt es sich um Nur-Text. |
| content |
Der Inhaltstyp der Antwort. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| creation |
Ruft den Erstellungszeitpunkt der Kommentarantwort ab. |
| id | Gibt den Bezeichner für Kommentarantworten an. |
| mentions | Die Entitäten (z. B. Personen), die in Kommentaren erwähnt werden. |
| resolved | Der Status der Kommentarantwort. Ein Wert von |
| rich |
Der umfangreiche Kommentarinhalt (z. B. Erwähnungen in Kommentaren). Diese Zeichenfolge ist nicht für Endbenutzer vorgesehen. Ihr Add-In sollte dies nur verwenden, um umfangreiche Kommentarinhalte zu analysieren. |
Methoden
| assign |
Weist die mit dem Kommentar verknüpfte Aufgabe dem angegebenen Benutzer als alleiniger Beauftragter zu. Wenn keine Aufgabe vorhanden ist, wird eine erstellt. |
| delete() | Löscht die Kommentarantwort. |
| get |
Ruft die Zelle ab, in der sich diese Kommentarantwort befindet. |
| get |
Ruft den übergeordneten Kommentar zu dieser Antwort ab. |
| get |
Ruft die Aufgabe ab, die dem Thread dieser Kommentarantwort zugeordnet ist. Wenn keine Aufgabe für den Kommentarthread vorhanden ist, wird eine |
| get |
Ruft die Aufgabe ab, die dem Thread dieser Kommentarantwort zugeordnet ist. Wenn keine Aufgabe für den Kommentarthread vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| update |
Updates den Inhalt des Kommentars mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen. |
Details zur Eigenschaft
authorEmail
Ruft die E-Mail des Autors der Kommentarantwort ab.
readonly authorEmail: string;Eigenschaftswert
string
Hinweise
authorName
Ruft den Namen des Autors der Kommentarantwort ab.
readonly authorName: string;Eigenschaftswert
string
Hinweise
content
Der Inhalt der Kommentarantwort. Bei der Zeichenfolge handelt es sich um Nur-Text.
content: string;Eigenschaftswert
string
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
const reply = comment.replies.getItemAt(0);
reply.load("content");
// Sync to load the content of the comment reply.
await context.sync();
// Append "Please!" to the end of the comment reply.
reply.content += " Please!";
await context.sync();
});
contentType
Der Inhaltstyp der Antwort.
readonly contentType: Excel.ContentType | "Plain" | "Mention";Eigenschaftswert
Excel.ContentType | "Plain" | "Mention"
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
creationDate
Ruft den Erstellungszeitpunkt der Kommentarantwort ab.
readonly creationDate: Date;Eigenschaftswert
Date
Hinweise
id
Gibt den Bezeichner für Kommentarantworten an.
readonly id: string;Eigenschaftswert
string
Hinweise
mentions
Die Entitäten (z. B. Personen), die in Kommentaren erwähnt werden.
readonly mentions: Excel.CommentMention[];Eigenschaftswert
Hinweise
resolved
Der Status der Kommentarantwort. Ein Wert von true bedeutet, dass sich die Antwort im aufgelösten Zustand befindet.
readonly resolved: boolean;Eigenschaftswert
boolean
Hinweise
richContent
Der umfangreiche Kommentarinhalt (z. B. Erwähnungen in Kommentaren). Diese Zeichenfolge ist nicht für Endbenutzer vorgesehen. Ihr Add-In sollte dies nur verwenden, um umfangreiche Kommentarinhalte zu analysieren.
readonly richContent: string;Eigenschaftswert
string
Hinweise
Details zur Methode
assignTask(assignee)
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Weist die mit dem Kommentar verknüpfte Aufgabe dem angegebenen Benutzer als alleiniger Beauftragter zu. Wenn keine Aufgabe vorhanden ist, wird eine erstellt.
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;Parameter
- assignee
- Excel.EmailIdentity
Die Informationen zur Benutzeridentität des Beauftragten.
Gibt zurück
Hinweise
delete()
Löscht die Kommentarantwort.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml
await Excel.run(async (context) => {
// Remove the first comment reply from this worksheet's first comment.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.getItemAt(0).delete();
await context.sync();
});
getLocation()
Ruft die Zelle ab, in der sich diese Kommentarantwort befindet.
getLocation(): Excel.Range;Gibt zurück
Hinweise
getParentComment()
Ruft den übergeordneten Kommentar zu dieser Antwort ab.
getParentComment(): Excel.Comment;Gibt zurück
Hinweise
getTask()
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft die Aufgabe ab, die dem Thread dieser Kommentarantwort zugeordnet ist. Wenn keine Aufgabe für den Kommentarthread vorhanden ist, wird eine ItemNotFound Ausnahme ausgelöst.
getTask(): Excel.DocumentTask;Gibt zurück
Hinweise
getTaskOrNullObject()
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft die Aufgabe ab, die dem Thread dieser Kommentarantwort zugeordnet ist. Wenn keine Aufgabe für den Kommentarthread vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getTaskOrNullObject(): Excel.DocumentTask;Gibt zurück
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.CommentReply;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CommentReply;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.CommentReplyUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.CommentReply): void;Parameter
- properties
- Excel.CommentReply
Gibt zurück
void
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.CommentReply Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.CommentReplyData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.CommentReplyData;Gibt zurück
updateMentions(contentWithMentions)
Updates den Inhalt des Kommentars mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen.
updateMentions(contentWithMentions: Excel.CommentRichContent): void;Parameter
- contentWithMentions
- Excel.CommentRichContent
Der Inhalt für den Kommentar. Dies enthält eine speziell formatierte Zeichenfolge und eine Liste von Erwähnungen, die bei der Anzeige durch Excel in die Zeichenfolge analysiert werden.
Gibt zurück
void