Excel.Comment class
Stellt einen Kommentar in der Arbeitsmappe dar.
- Extends
Hinweise
Eigenschaften
| author |
Ruft die E-Mail des Autors des Kommentars ab. |
| author |
Ruft den Namen des Autors des Kommentars ab. |
| content | Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| creation |
Ruft den Erstellungszeitpunkt des Kommentars ab. Gibt zurück |
| id | Gibt den Kommentarbezeichner an. |
| mentions | Ruft die Entitäten (z. B. Personen) ab, die in Kommentaren erwähnt werden. |
| replies | Stellt eine Sammlung der Antwortobjekte dar, die dem Kommentar zugeordnet sind. |
| resolved | Der Kommentarthread status. Der Wert bedeutet |
| rich |
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. |
Methoden
| delete() | Löscht den Kommentar und alle verbundenen Antworten. |
| get |
Ruft die Zelle ab, in der sich dieser Kommentar befindet. |
| 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 Kommentarinhalt mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen. |
Details zur Eigenschaft
authorEmail
Ruft die E-Mail des Autors des Kommentars ab.
readonly authorEmail: string;Eigenschaftswert
string
Hinweise
authorName
Ruft den Namen des Autors des Kommentars ab.
readonly authorName: string;Eigenschaftswert
string
Hinweise
content
Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text.
content: string;Eigenschaftswert
string
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.content = "PLEASE add headers here.";
await context.sync();
});
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
creationDate
Ruft den Erstellungszeitpunkt des Kommentars ab. Gibt zurück null , wenn der Kommentar aus einer Notiz konvertiert wurde, da der Kommentar kein Erstellungsdatum hat.
readonly creationDate: Date;Eigenschaftswert
Date
Hinweise
id
Gibt den Kommentarbezeichner an.
readonly id: string;Eigenschaftswert
string
Hinweise
mentions
Ruft die Entitäten (z. B. Personen) ab, die in Kommentaren erwähnt werden.
readonly mentions: Excel.CommentMention[];Eigenschaftswert
Hinweise
replies
Stellt eine Sammlung der Antwortobjekte dar, die dem Kommentar zugeordnet sind.
readonly replies: Excel.CommentReplyCollection;Eigenschaftswert
Hinweise
resolved
Der Kommentarthread status. Der Wert bedeutet true , dass der Kommentarthread aufgelöst wird.
resolved: boolean;Eigenschaftswert
boolean
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
sheet.comments.getItemAt(0).resolved = true;
await context.sync();
});
richContent
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.
readonly richContent: string;Eigenschaftswert
string
Hinweise
Details zur Methode
delete()
Löscht den Kommentar und alle verbundenen Antworten.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
context.workbook.comments.getItemByCell("Comments!A2").delete();
await context.sync();
});
getLocation()
Ruft die Zelle ab, in der sich dieser Kommentar befindet.
getLocation(): Excel.Range;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.CommentLoadOptions): Excel.Comment;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.Comment;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
const comment = context.workbook.comments.getItemByCell("Comments!A2");
comment.load(["authorEmail", "authorName", "creationDate"]);
await context.sync();
console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
await context.sync();
});
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.Comment;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen 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.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.CommentUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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.Comment): void;Parameter
- properties
- Excel.Comment
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 das Objekt übergeben wird.) Während das ursprüngliche Excel.Comment Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.CommentData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.CommentData;Gibt zurück
updateMentions(contentWithMentions)
Updates den Kommentarinhalt mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen.
updateMentions(contentWithMentions: Excel.CommentRichContent): void;Parameter
- contentWithMentions
- Excel.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
Hinweise
Office Add-ins