Excel.CommentReplyCollection class
Stellt eine Sammlung von Kommentarantwortobjekten dar, die Teil des Kommentars sind.
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. 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, content |
Erstellt einen Kommentar, Antwort auf einen Kommentar. |
| add(content, content |
Erstellt einen Kommentar, Antwort auf einen Kommentar. |
| get |
Ruft die Anzahl der Kommentarantworten in der Sammlung ab. |
| get |
Gibt eine Kommentarantwort zurück, die durch ihre ID angegeben ist. |
| get |
Ruft eine Kommentarantwort basierend auf ihrer Position in der Sammlung ab. |
| get |
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 |
| 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 |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. 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 einen Kommentar, Antwort auf 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 Objekt CommentRichContent sein (z. B. für Kommentare mit Erwähnungen). [API-Set: ExcelApi 1.10 für Zeichenfolge, 1.11 für CommentRichContent-Objekt]
- contentType
- Excel.ContentType
Optional. Der Inhaltstyp des Kommentars. Der Standardwert ist enum ContentType.Plain. [API-Set: 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-comments-and-notes/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, contentType)
Erstellt einen Kommentar, Antwort auf einen Kommentar.
add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply;Parameter
- content
-
Excel.CommentRichContent | string
Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder ein Objekt CommentRichContent sein (z. B. für Kommentare mit Erwähnungen). [API-Set: ExcelApi 1.10 für Zeichenfolge, 1.11 für CommentRichContent-Objekt]
- contentType
-
"Plain" | "Mention"
Optional. Der Inhaltstyp des Kommentars. Der Standardwert ist enum ContentType.Plain. [API-Set: ExcelApi 1.10 für Enum ContentType.Plain, 1.11 für Enum ContentType.Mention]
Gibt zurück
Hinweise
getCount()
Ruft die Anzahl der Kommentarantworten in der Sammlung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
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
getItemAt(index)
Ruft eine Kommentarantwort basierend auf ihrer Position in der Sammlung ab.
getItemAt(index: number): Excel.CommentReply;Parameter
- index
-
number
Der Indexwert der Kommentarantwort, die abgerufen werden soll. Die Sammlung verwendet eine Null-basierte Indizierung.
Gibt zurück
Hinweise
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 festgelegt ist true. 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
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas 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 sie ü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 Sammlung enthält.
toJSON(): Excel.Interfaces.CommentReplyCollectionData;