Excel.CommentCollection class
Stellt eine Auflistung von Kommentarobjekten dar, die Teil der Arbeitsmappe sind.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(cell |
Erstellt einen neuen Kommentar mit dem angegebenen Inhalt auf der angegebenen Zelle. Ein |
| add(cell |
Erstellt einen neuen Kommentar mit dem angegebenen Inhalt auf der angegebenen Zelle. Ein |
| get |
Ruft die Anzahl der Kommentare in der Sammlung ab. |
| get |
Ruft einen Kommentar aus der Sammlung basierend auf der ID ab. |
| get |
Ruft einen Kommentar aus der Sammlung basierend auf ihrer Position ab. |
| get |
Ruft den Kommentar aus der angegebenen Zelle ab. Wenn in der Zelle kein Kommentar vorhanden ist, wird ein Fehler ausgelöst. |
| get |
Ruft den Kommentar ab, mit dem die angegebene Antwort verbunden ist. |
| get |
Ruft einen Kommentar aus der Sammlung basierend auf der ID ab. Wenn das Comment-Objekt nicht 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 " |
| toJSON() | Überschreibt die JavaScript-Methode |
Ereignisse
| on |
Tritt ein, wenn die Kommentare hinzugefügt werden. |
| on |
Tritt auf, wenn Kommentare oder Antworten in einer Kommentarsammlung geändert werden, auch wenn Antworten gelöscht werden. |
| on |
Tritt auf, wenn Kommentare in der Kommentarauflistung gelöscht werden. |
Details zur Eigenschaft
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
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.Comment[];Eigenschaftswert
Details zur Methode
add(cellAddress, content, contentType)
Erstellt einen neuen Kommentar mit dem angegebenen Inhalt auf der angegebenen Zelle. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.
add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment;Parameter
- cellAddress
-
Excel.Range | string
Die Zelle, der der Kommentar hinzugefügt wird. Dies kann ein Range Objekt oder eine Zeichenfolge sein. Wenn es sich um eine Zeichenfolge handelt, muss sie die vollständige Adresse einschließlich des Blattnamens enthalten. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.
- content
-
Excel.CommentRichContent | string
Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder CommentRichContent ein Objekt sein. Zeichenfolgen werden für Nur-Text verwendet. CommentRichContent -Objekte ermöglichen andere Kommentarfeatures, z. B. Erwähnungen. [API-Satz: ExcelApi 1.10 für Zeichenfolge, 1.11 für CommentRichContent-Objekt]
- contentType
- Excel.ContentType
Optional. Der Inhaltstyp, der im Kommentar enthalten ist. Der Standardwert ist enum ContentType.Plain. [API-Satz: ExcelApi 1.10 für Enum ContentType.Plain, 1.11 für Enum ContentType.Mention]
Gibt zurück
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");
// Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
sheet.comments.add("A2", "TODO: add data.");
await context.sync();
});
add(cellAddress, content, contentTypeString)
Erstellt einen neuen Kommentar mit dem angegebenen Inhalt auf der angegebenen Zelle. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.
add(cellAddress: Range | string, content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.Comment;Parameter
- cellAddress
-
Excel.Range | string
Die Zelle, der der Kommentar hinzugefügt wird. Dies kann ein Range Objekt oder eine Zeichenfolge sein. Wenn es sich um eine Zeichenfolge handelt, muss sie die vollständige Adresse einschließlich des Blattnamens enthalten. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.
- content
-
Excel.CommentRichContent | string
Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder CommentRichContent ein Objekt sein. Zeichenfolgen werden für Nur-Text verwendet. CommentRichContent -Objekte ermöglichen andere Kommentarfeatures, z. B. Erwähnungen. [API-Satz: ExcelApi 1.10 für Zeichenfolge, 1.11 für CommentRichContent-Objekt]
- contentTypeString
-
"Plain" | "Mention"
Optional. Der Inhaltstyp, der im Kommentar enthalten ist. Der Standardwert ist enum ContentType.Plain. [API-Satz: ExcelApi 1.10 für Enum ContentType.Plain, 1.11 für Enum ContentType.Mention]
Gibt zurück
Hinweise
getCount()
Ruft die Anzahl der Kommentare in der Sammlung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(commentId)
Ruft einen Kommentar aus der Sammlung basierend auf der ID ab.
getItem(commentId: string): Excel.Comment;Parameter
- commentId
-
string
Der Bezeichner für den Kommentar.
Gibt zurück
Hinweise
getItemAt(index)
Ruft einen Kommentar aus der Sammlung basierend auf ihrer Position ab.
getItemAt(index: number): Excel.Comment;Parameter
- index
-
number
Index-Wert des abzurufenden Objekts. Nullindiziert.
Gibt zurück
Hinweise
getItemByCell(cellAddress)
Ruft den Kommentar aus der angegebenen Zelle ab. Wenn in der Zelle kein Kommentar vorhanden ist, wird ein Fehler ausgelöst.
getItemByCell(cellAddress: Range | string): Excel.Comment;Parameter
- cellAddress
-
Excel.Range | string
Die Zelle, in der sich der Kommentar befindet. Dies kann ein Range Objekt oder eine Zeichenfolge sein. Wenn es sich um eine Zeichenfolge handelt, muss sie die vollständige Adresse einschließlich des Blattnamens enthalten. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.
Gibt zurück
Hinweise
getItemByReplyId(replyId)
Ruft den Kommentar ab, mit dem die angegebene Antwort verbunden ist.
getItemByReplyId(replyId: string): Excel.Comment;Parameter
- replyId
-
string
Der Bezeichner der Kommentarantwort.
Gibt zurück
Hinweise
getItemOrNullObject(commentId)
Ruft einen Kommentar aus der Sammlung basierend auf der ID ab. Wenn das Comment-Objekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(commentId: string): Excel.Comment;Parameter
- commentId
-
string
Der Bezeichner für den Kommentar.
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.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;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.CommentCollection;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?: OfficeExtension.LoadOption): Excel.CommentCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.CommentCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.CommentCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.CommentCollectionData;Gibt zurück
Details zum Ereignis
onAdded
Tritt ein, wenn die Kommentare hinzugefügt werden.
readonly onAdded: OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>;Ereignistyp
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml
await Excel.run(async (context) => {
const comments = context.workbook.worksheets.getActiveWorksheet().comments;
// Register the onAdded, onChanged, and onDeleted comment event handlers.
comments.onAdded.add(commentAdded);
comments.onChanged.add(commentChanged);
comments.onDeleted.add(commentDeleted);
await context.sync();
console.log("Added event handlers for when comments are added, changed, or deleted.");
});
...
async function commentAdded(event: Excel.CommentAddedEventArgs) {
// Retrieve the added comment using the comment ID.
// Note: This function assumes only a single comment is added at a time.
await Excel.run(async (context) => {
const addedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);
// Load the added comment's data.
addedComment.load(["content", "authorName", "creationDate"]);
await context.sync();
// Print out the added comment's data.
console.log(`A comment was added:`);
console.log(` ID: ${event.commentDetails[0].commentId}`);
console.log(` Comment content:${addedComment.content}`);
console.log(` Comment author:${addedComment.authorName}`);
console.log(` Creation date:${addedComment.creationDate}`);
});
}
onChanged
Tritt auf, wenn Kommentare oder Antworten in einer Kommentarsammlung geändert werden, auch wenn Antworten gelöscht werden.
readonly onChanged: OfficeExtension.EventHandlers<Excel.CommentChangedEventArgs>;Ereignistyp
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml
await Excel.run(async (context) => {
const comments = context.workbook.worksheets.getActiveWorksheet().comments;
// Register the onAdded, onChanged, and onDeleted comment event handlers.
comments.onAdded.add(commentAdded);
comments.onChanged.add(commentChanged);
comments.onDeleted.add(commentDeleted);
await context.sync();
console.log("Added event handlers for when comments are added, changed, or deleted.");
});
...
async function commentChanged(event: Excel.CommentChangedEventArgs) {
// Retrieve the changed comment using the comment ID.
// Note: This function assumes only a single comment is changed at a time.
await Excel.run(async (context) => {
const changedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);
// Load the changed comment's data.
changedComment.load(["content", "authorName", "creationDate"]);
await context.sync();
// Print out the changed comment's data.
console.log(`A comment was changed:`);
console.log(` ID: ${event.commentDetails[0].commentId}`);
console.log(` Updated comment content: ${changedComment.content}`);
console.log(` Comment author: ${changedComment.authorName}`);
console.log(` Creation date: ${changedComment.creationDate}`);
});
}
onDeleted
Tritt auf, wenn Kommentare in der Kommentarauflistung gelöscht werden.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>;Ereignistyp
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml
await Excel.run(async (context) => {
const comments = context.workbook.worksheets.getActiveWorksheet().comments;
// Register the onAdded, onChanged, and onDeleted comment event handlers.
comments.onAdded.add(commentAdded);
comments.onChanged.add(commentChanged);
comments.onDeleted.add(commentDeleted);
await context.sync();
console.log("Added event handlers for when comments are added, changed, or deleted.");
});
...
async function commentDeleted(event: Excel.CommentDeletedEventArgs) {
// Print out the deleted comment's ID.
// Note: This function assumes only a single comment is deleted at a time.
await Excel.run(async (context) => {
console.log(`A comment was deleted:`);
console.log(` ID: ${event.commentDetails[0].commentId}`);
});
}
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