Word.Comment class
Stellt einen Kommentar im Dokument dar.
- Extends
Hinweise
Eigenschaften
| author |
Ruft die E-Mail des Autors des Kommentars ab. |
| author |
Ruft den Namen des Autors des Kommentars ab. |
| content | Gibt den Inhalt des Kommentars als Nur-Text an. |
| content |
Gibt den Inhaltsbereich des Kommentars an. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| creation |
Ruft das Erstellungsdatum des Kommentars ab. |
| id | Ruft die ID des Kommentars ab. |
| replies | Ruft die Auflistung von Antwortobjekten ab, die dem Kommentar zugeordnet sind. |
| resolved | Gibt die status des Kommentarthreads an. Wenn Sie auf true festlegen, wird der Kommentarthread aufgelöst. Wenn sie den Wert true erhalten, bedeutet das, dass der Kommentarthread aufgelöst wird. |
Methoden
| delete() | Löscht den Kommentar und seine Antworten. |
| get |
Ruft den Bereich im Standard Dokument ab, in dem sich der 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 " |
| reply(reply |
Fügt am Ende des Kommentarthreads eine neue Antwort hinzu. |
| 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 |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
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
Gibt den Inhalt des Kommentars als Nur-Text an.
content: string;Eigenschaftswert
string
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Edits the first comment in the selected content.
await Word.run(async (context) => {
const text = $("#edit-comment-text")
.val()
.toString();
const comment = context.document
.getSelection()
.getComments()
.getFirst();
comment.content = text;
// Load object to log in the console.
comment.load();
await context.sync();
console.log("Comment content changed:", comment);
});
contentRange
Gibt den Inhaltsbereich des Kommentars an.
contentRange: Word.CommentContentRange;Eigenschaftswert
Hinweise
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 das Erstellungsdatum des Kommentars ab.
readonly creationDate: Date;Eigenschaftswert
Date
Hinweise
id
Ruft die ID des Kommentars ab.
readonly id: string;Eigenschaftswert
string
Hinweise
replies
Ruft die Auflistung von Antwortobjekten ab, die dem Kommentar zugeordnet sind.
readonly replies: Word.CommentReplyCollection;Eigenschaftswert
Hinweise
resolved
Gibt die status des Kommentarthreads an. Wenn Sie auf true festlegen, wird der Kommentarthread aufgelöst. Wenn sie den Wert true erhalten, bedeutet das, 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/word/50-document/manage-comments.yaml
// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
const comment = context.document
.getSelection()
.getComments()
.getFirst();
comment.load("resolved");
await context.sync();
// Toggle resolved status.
// If the comment is active, set as resolved.
// If it's resolved, set resolved to false.
const resolvedBefore = comment.resolved;
comment.resolved = !resolvedBefore;
comment.load();
await context.sync();
console.log(`Comment Resolved status: ${comment.resolved}`, comment);
});
Details zur Methode
delete()
Löscht den Kommentar und seine Antworten.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Deletes the first comment in the selected content.
await Word.run(async (context) => {
context.document
.getSelection()
.getComments()
.getFirst()
.delete();
await context.sync();
console.log("Comment deleted");
});
getRange()
Ruft den Bereich im Standard Dokument ab, in dem sich der Kommentar befindet.
getRange(): Word.Range;Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
const range = context.document
.getSelection()
.getComments()
.getFirst()
.getRange();
range.load("text");
await context.sync();
console.log(`Comment location: ${range.text}`);
});
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?: Word.Interfaces.CommentLoadOptions): Word.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[]): Word.Comment;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;
}): Word.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
reply(replyText)
Fügt am Ende des Kommentarthreads eine neue Antwort hinzu.
reply(replyText: string): Word.CommentReply;Parameter
- replyText
-
string
Erforderlich. Antworttext.
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
const text = $("#reply-text")
.val()
.toString();
const comments = context.document.getSelection().getComments();
comments.load("items");
await context.sync();
const firstActiveComment = comments.items.find((item) => item.resolved !== true);
if (firstActiveComment) {
const reply = firstActiveComment.reply(text);
console.log("Reply added");
} else {
console.log("No active comment was found in the selection so couldn't reply.");
}
});
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
- Word.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: Word.Comment): void;Parameter
- properties
- Word.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.) Die ursprüngliche Word. Comment-Objekt ist ein API-Objekt, die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.CommentData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.CommentData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.Comment;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Comment;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für