Excel.DocumentProperties class
Stellt Arbeitsmappeneigenschaften dar.
- Extends
Hinweise
Eigenschaften
| author | Der Autor der Arbeitsmappe. |
| category | Die Kategorie der Arbeitsmappe. |
| comments | Die Kommentare der Arbeitsmappe. |
| company | Das Unternehmen der Arbeitsmappe. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| creation |
Ruft das Erstellungsdatum der Arbeitsmappe ab. |
| custom | Ruft die Sammlung der benutzerdefinierten Eigenschaften der Arbeitsmappe ab. |
| keywords | Die Schlüsselwörter der Arbeitsmappe. |
| last |
Ruft den letzten Autor der Arbeitsmappe ab. |
| manager | Der Manager der Arbeitsmappe. |
| revision |
Ruft die Revisionsnummer der Arbeitsmappe ab. |
| subject | Der Betreff der Arbeitsmappe. |
| title | Der Titel der Arbeitsmappe. |
Methoden
| 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 " |
| set(properties, options) | 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) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
author
Der Autor der Arbeitsmappe.
author: string;Eigenschaftswert
string
Hinweise
category
Die Kategorie der Arbeitsmappe.
category: string;Eigenschaftswert
string
Hinweise
comments
Die Kommentare der Arbeitsmappe.
comments: string;Eigenschaftswert
string
Hinweise
company
Das Unternehmen der Arbeitsmappe.
company: string;Eigenschaftswert
string
Hinweise
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
creationDate
Ruft das Erstellungsdatum der Arbeitsmappe ab.
readonly creationDate: Date;Eigenschaftswert
Date
Hinweise
custom
Ruft die Sammlung der benutzerdefinierten Eigenschaften der Arbeitsmappe ab.
readonly custom: Excel.CustomPropertyCollection;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Load the keys and values of all custom properties.
const customDocProperties = context.workbook.properties.custom;
customDocProperties.load(["key", "value"]);
await context.sync();
// Log each custom property to the console.
// Note that your document may have more properties than those you have set using this snippet.
customDocProperties.items.forEach((property) => {
console.log(`${property.key}:${property.value}`);
});
});
keywords
Die Schlüsselwörter der Arbeitsmappe.
keywords: string;Eigenschaftswert
string
Hinweise
lastAuthor
Ruft den letzten Autor der Arbeitsmappe ab.
readonly lastAuthor: string;Eigenschaftswert
string
Hinweise
manager
Der Manager der Arbeitsmappe.
manager: string;Eigenschaftswert
string
Hinweise
revisionNumber
Ruft die Revisionsnummer der Arbeitsmappe ab.
revisionNumber: number;Eigenschaftswert
number
Hinweise
subject
Der Betreff der Arbeitsmappe.
subject: string;Eigenschaftswert
string
Hinweise
title
Der Titel der Arbeitsmappe.
title: string;Eigenschaftswert
string
Hinweise
Details zur Methode
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.DocumentPropertiesLoadOptions): Excel.DocumentProperties;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.DocumentProperties;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?: {
select?: string;
expand?: string;
}): Excel.DocumentProperties;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
set(properties, options)
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.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.DocumentProperties): void;Parameter
- properties
- Excel.DocumentProperties
Gibt zurück
void
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.DocumentProperties-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DocumentPropertiesData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.DocumentPropertiesData;Gibt zurück
Office Add-ins