Excel.Comment class

Ruft die E-Mail des Autors des Kommentars ab.

readonly authorEmail: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Ruft den Namen des Autors des Kommentars ab.

readonly authorName: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Der Inhalt des Kommentars. Die Zeichenfolge ist Nur-Text.

content: string;

Eigenschaftswert

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");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

Ruft den Inhaltstyp des Kommentars ab.

readonly contentType: Excel.ContentType | "Plain" | "Mention";

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.12 ]

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 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

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Gibt den Kommentarbezeichner an.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Ruft die Entitäten (z. B. Personen) ab, die in Kommentaren erwähnt werden.

readonly mentions: Excel.CommentMention[];

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Stellt eine Sammlung der Antwortobjekte dar, die dem Kommentar zugeordnet sind.

readonly replies: Excel.CommentReplyCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

Der Kommentarthread status. Der Wert bedeutet true , dass der Kommentarthread aufgelöst wird.

resolved: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.11 ]

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

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

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Löscht den Kommentar und alle verbundenen Antworten.

delete(): void;

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) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

Ruft die Zelle ab, in der sich dieser Kommentar befindet.

getLocation(): Excel.Range;

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.CommentLoadOptions): Excel.Comment;

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.Comment;

Parameter

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

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

Gibt zurück

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

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Comment): void;

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.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

Updates den Kommentarinhalt mit einer speziell formatierten Zeichenfolge und einer Liste von Erwähnungen.

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.11 ]