Word.DocumentProperties class
Stellt Dokumenteigenschaften dar.
- Extends
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml
await Word.run(async (context) => {
const builtInProperties: Word.DocumentProperties = context.document.properties;
builtInProperties.load("*"); // Let's get all!
await context.sync();
console.log(JSON.stringify(builtInProperties, null, 4));
});
Eigenschaften
| application |
Ruft den Anwendungsnamen des Dokuments ab. |
| author | Gibt den Autor des Dokuments an. |
| category | Gibt die Kategorie des Dokuments an. |
| comments | Gibt das Feld Kommentare in den Metadaten des Dokuments an. Diese haben keine Verbindung zu Kommentaren von Benutzern, die im Dokument gemacht wurden. |
| company | Gibt das Unternehmen des Dokuments an. |
| 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 des Dokuments ab. |
| custom |
Ruft die Sammlung der benutzerdefinierten Eigenschaften des Dokuments ab. |
| format | Gibt das Format des Dokuments an. |
| keywords | Gibt die Schlüsselwörter des Dokuments an. |
| last |
Ruft den letzten Autor des Dokuments ab. |
| last |
Ruft das letzte Druckdatum des Dokuments ab. |
| last |
Ruft die Zeit der letzten Speicherung des Dokuments ab. |
| manager | Gibt den Manager des Dokuments an. |
| revision |
Ruft die Revisionsnummer des Dokuments ab. |
| security | Ruft die Sicherheitseinstellungen des Dokuments ab. Einige sind Zugriffsbeschränkungen für die Datei auf dem Datenträger. Andere sind Dokumentschutzeinstellungen. Einige mögliche Werte sind 0 = Die Datei auf dem Datenträger hat Lese-/Schreibzugriff; 1 = Dokument schützen: Die Datei ist verschlüsselt und erfordert ein Kennwort zum Öffnen; 2 = Dokument schützen: Immer schreibgeschützt geöffnet; 3 = Dokument schützen: Sowohl #1 als auch #2; 4 = Die Datei auf dem Datenträger ist schreibgeschützt; 5 = Sowohl #1 als auch #4; 6 = Sowohl #2 als auch #4; 7 = Alle 1, 2 und 4; 8 = Dokument schützen: Bearbeiten auf schreibgeschützt beschränken; 9 = Sowohl #1 als auch #8; 10 = Sowohl #2 als auch #8; 11 = Alle von #1, #2 und #8; 12 = Sowohl #4 als auch #8; 13 = Alles von #1, #4 und #8; 14 = Alle von #2, #4 und #8; 15 = Alles von #1, #2, #4 und #8. |
| subject | Gibt den Betreff des Dokuments an. |
| template | Ruft die Vorlage des Dokuments ab. |
| title | Gibt den Titel des Dokuments an. |
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 |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
Details zur Eigenschaft
applicationName
Ruft den Anwendungsnamen des Dokuments ab.
readonly applicationName: string;Eigenschaftswert
string
Hinweise
author
Gibt den Autor des Dokuments an.
author: string;Eigenschaftswert
string
Hinweise
category
Gibt die Kategorie des Dokuments an.
category: string;Eigenschaftswert
string
Hinweise
comments
Gibt das Feld Kommentare in den Metadaten des Dokuments an. Diese haben keine Verbindung zu Kommentaren von Benutzern, die im Dokument gemacht wurden.
comments: string;Eigenschaftswert
string
Hinweise
company
Gibt das Unternehmen des Dokuments an.
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 des Dokuments ab.
readonly creationDate: Date;Eigenschaftswert
Date
Hinweise
customProperties
Ruft die Sammlung der benutzerdefinierten Eigenschaften des Dokuments ab.
readonly customProperties: Word.CustomPropertyCollection;Eigenschaftswert
Hinweise
format
Gibt das Format des Dokuments an.
format: string;Eigenschaftswert
string
Hinweise
keywords
Gibt die Schlüsselwörter des Dokuments an.
keywords: string;Eigenschaftswert
string
Hinweise
lastAuthor
Ruft den letzten Autor des Dokuments ab.
readonly lastAuthor: string;Eigenschaftswert
string
Hinweise
lastPrintDate
Ruft das letzte Druckdatum des Dokuments ab.
readonly lastPrintDate: Date;Eigenschaftswert
Date
Hinweise
lastSaveTime
Ruft die Zeit der letzten Speicherung des Dokuments ab.
readonly lastSaveTime: Date;Eigenschaftswert
Date
Hinweise
manager
Gibt den Manager des Dokuments an.
manager: string;Eigenschaftswert
string
Hinweise
revisionNumber
Ruft die Revisionsnummer des Dokuments ab.
readonly revisionNumber: string;Eigenschaftswert
string
Hinweise
security
Ruft die Sicherheitseinstellungen des Dokuments ab. Einige sind Zugriffsbeschränkungen für die Datei auf dem Datenträger. Andere sind Dokumentschutzeinstellungen. Einige mögliche Werte sind 0 = Die Datei auf dem Datenträger hat Lese-/Schreibzugriff; 1 = Dokument schützen: Die Datei ist verschlüsselt und erfordert ein Kennwort zum Öffnen; 2 = Dokument schützen: Immer schreibgeschützt geöffnet; 3 = Dokument schützen: Sowohl #1 als auch #2; 4 = Die Datei auf dem Datenträger ist schreibgeschützt; 5 = Sowohl #1 als auch #4; 6 = Sowohl #2 als auch #4; 7 = Alle 1, 2 und 4; 8 = Dokument schützen: Bearbeiten auf schreibgeschützt beschränken; 9 = Sowohl #1 als auch #8; 10 = Sowohl #2 als auch #8; 11 = Alle von #1, #2 und #8; 12 = Sowohl #4 als auch #8; 13 = Alles von #1, #4 und #8; 14 = Alle von #2, #4 und #8; 15 = Alles von #1, #2, #4 und #8.
readonly security: number;Eigenschaftswert
number
Hinweise
subject
Gibt den Betreff des Dokuments an.
subject: string;Eigenschaftswert
string
Hinweise
template
Ruft die Vorlage des Dokuments ab.
readonly template: string;Eigenschaftswert
string
Hinweise
title
Gibt den Titel des Dokuments an.
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?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.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[]): Word.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;
}): Word.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
- properties
- Word.Interfaces.DocumentPropertiesUpdateData
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: Word.DocumentProperties): void;Parameter
- properties
- Word.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 Word.DocumentProperties Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.DocumentPropertiesData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.DocumentPropertiesData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.DocumentProperties;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.DocumentProperties;Gibt zurück
Office Add-ins