Excel.CommentCollection class

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.Comment[];

Eigenschaftswert

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

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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();
});

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

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Ruft die Anzahl der Kommentare in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Ruft einen Kommentar aus der Sammlung basierend auf der ID ab.

getItem(commentId: string): Excel.Comment;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Ruft einen Kommentar aus der Sammlung basierend auf ihrer Position ab.

getItemAt(index: number): Excel.Comment;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Ruft den Kommentar ab, mit dem die angegebene Antwort verbunden ist.

getItemByReplyId(replyId: string): Excel.Comment;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Ü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

Tritt ein, wenn die Kommentare hinzugefügt werden.

readonly onAdded: OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.12 ]

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}`);
    });
}

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

[ API-Satz: ExcelApi 1.12 ]

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}`);
    });
}

Tritt auf, wenn Kommentare in der Kommentarauflistung gelöscht werden.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.12 ]

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}`);
    });
}