Excel.CommentReplyCollection class

Stellt eine Auflistung von Kommentarantwortobjekten dar, die Teil des Kommentars sind.

Extends

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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(content, contentType)

Erstellt eine Kommentarantwort für einen Kommentar.

add(content, contentTypeString)

Erstellt eine Kommentarantwort für einen Kommentar.

getCount()

Ruft die Anzahl der Kommentarantworten in der Sammlung ab.

getItem(commentReplyId)

Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist.

getItemAt(index)

Ruft eine Kommentarantwort basierend auf ihrer Position in der Sammlung ab.

getItemOrNullObject(commentReplyId)

Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist. Wenn das Kommentarantwortobjekt 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.

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

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.CommentReplyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.CommentReplyCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

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.CommentReply[];

Eigenschaftswert

Details zur Methode

add(content, contentType)

Erstellt eine Kommentarantwort für einen Kommentar.

add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;

Parameter

content

Excel.CommentRichContent | string

Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder ein CommentRichContent Objekt sein (z. B. für Kommentare mit 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

[ API-Satz: ExcelApi 1.10 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml

await Excel.run(async (context) => {
    // Adds a reply to the first comment in this worksheet.
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.replies.add("Add content to this worksheet.");
    await context.sync();
});

add(content, contentTypeString)

Erstellt eine Kommentarantwort für einen Kommentar.

add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;

Parameter

content

Excel.CommentRichContent | string

Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder ein CommentRichContent Objekt sein (z. B. für Kommentare mit 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

[ API-Satz: ExcelApi 1.10 ]

getCount()

Ruft die Anzahl der Kommentarantworten in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

getItem(commentReplyId)

Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist.

getItem(commentReplyId: string): Excel.CommentReply;

Parameter

commentReplyId

string

Der Bezeichner für die Kommentarantwort.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

getItemAt(index)

Ruft eine Kommentarantwort basierend auf ihrer Position in der Sammlung ab.

getItemAt(index: number): Excel.CommentReply;

Parameter

index

number

Der Indexwert der abzurufenden Kommentarantwort. Die Auflistung verwendet eine nullbasierte Indizierung.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.10 ]

getItemOrNullObject(commentReplyId)

Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist. Wenn das Kommentarantwortobjekt 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(commentReplyId: string): Excel.CommentReply;

Parameter

commentReplyId

string

Der Bezeichner für die Kommentarantwort.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.14 ]

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.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;

Parameter

options

Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

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.CommentReplyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.CommentReplyCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.CommentReplyCollectionData;

Gibt zurück