Word.DocumentProperties class

  • Référence
Paquet:
word

Représente les propriétés du document.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

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

Propriétés

applicationName

Obtient le nom d’application du document.
author

Spécifie l’auteur du document.
category

Spécifie la catégorie du document.
comments

Spécifie le champ Commentaires dans les métadonnées du document. Ceux-ci n’ont aucun lien avec les commentaires des utilisateurs effectués dans le document.
company

Spécifie la société du document.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
creationDate

Obtient la date de création du document.
customProperties

Obtient la collection de propriétés personnalisées du document.
format

Spécifie le format du document.
keywords

Spécifie les mots clés du document.
lastAuthor

Obtient le dernier auteur du document.
lastPrintDate

Obtient la dernière date d’impression du document.
lastSaveTime

Obtient la dernière heure d’enregistrement du document.
manager

Spécifie le gestionnaire du document.
revisionNumber

Obtient le numéro de révision du document.
security

Obtient les paramètres de sécurité du document. Certaines sont des restrictions d’accès sur le fichier sur le disque. D’autres sont des paramètres De protection de document. Certaines valeurs possibles sont 0 = Le fichier sur disque est en lecture/écriture ; 1 = Protéger le document : le fichier est chiffré et nécessite un mot de passe pour s’ouvrir. 2 = Protéger le document : Toujours ouvert en lecture seule ; 3 = Protéger le document : #1 et #2 ; 4 = Le fichier sur disque est en lecture seule ; 5 = #1 et #4 ; 6 = #2 et #4 ; 7 = tous les nombres de #1, #2 et #4 ; 8 = Protéger le document : restreindre la modification en lecture seule ; 9 = #1 et #8 ; 10 = #2 et #8 ; 11 = Tout de #1, #2 et #8 ; 12 = #4 et #8 ; 13 = Tout de #1, #4 et #8 ; 14 = Tout de #2, #4 et #8 ; 15 = Tout de #1, #2, #4 et #8.
subject

Spécifie l’objet du document.
template

Obtient le modèle du document.
title

Spécifie le titre du document.

Méthodes

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.DocumentProperties est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DocumentPropertiesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

applicationName

Obtient le nom d’application du document.

readonly applicationName: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

author

Spécifie l’auteur du document.

author: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

category

Spécifie la catégorie du document.

category: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

comments

Spécifie le champ Commentaires dans les métadonnées du document. Ceux-ci n’ont aucun lien avec les commentaires des utilisateurs effectués dans le document.

comments: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

company

Spécifie la société du document.

company: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

creationDate

Obtient la date de création du document.

readonly creationDate: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : WordApi 1.3 ]

customProperties

Obtient la collection de propriétés personnalisées du document.

readonly customProperties: Word.CustomPropertyCollection;

Valeur de propriété

Word.CustomPropertyCollection

Remarques

[ Ensemble d’API : WordApi 1.3 ]

format

Spécifie le format du document.

format: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

keywords

Spécifie les mots clés du document.

keywords: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

lastAuthor

Obtient le dernier auteur du document.

readonly lastAuthor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

lastPrintDate

Obtient la dernière date d’impression du document.

readonly lastPrintDate: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : WordApi 1.3 ]

lastSaveTime

Obtient la dernière heure d’enregistrement du document.

readonly lastSaveTime: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : WordApi 1.3 ]

manager

Spécifie le gestionnaire du document.

manager: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

revisionNumber

Obtient le numéro de révision du document.

readonly revisionNumber: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

security

Obtient les paramètres de sécurité du document. Certaines sont des restrictions d’accès sur le fichier sur le disque. D’autres sont des paramètres De protection de document. Certaines valeurs possibles sont 0 = Le fichier sur disque est en lecture/écriture ; 1 = Protéger le document : le fichier est chiffré et nécessite un mot de passe pour s’ouvrir. 2 = Protéger le document : Toujours ouvert en lecture seule ; 3 = Protéger le document : #1 et #2 ; 4 = Le fichier sur disque est en lecture seule ; 5 = #1 et #4 ; 6 = #2 et #4 ; 7 = tous les nombres de #1, #2 et #4 ; 8 = Protéger le document : restreindre la modification en lecture seule ; 9 = #1 et #8 ; 10 = #2 et #8 ; 11 = Tout de #1, #2 et #8 ; 12 = #4 et #8 ; 13 = Tout de #1, #4 et #8 ; 14 = Tout de #2, #4 et #8 ; 15 = Tout de #1, #2, #4 et #8.

readonly security: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

subject

Spécifie l’objet du document.

subject: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

template

Obtient le modèle du document.

readonly template: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

title

Spécifie le titre du document.

title: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Détails de la méthode

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties;

Paramètres

options
Word.Interfaces.DocumentPropertiesLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.DocumentProperties

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.DocumentProperties;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.DocumentProperties

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.DocumentProperties;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.DocumentProperties

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Word.Interfaces.DocumentPropertiesUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.DocumentProperties): void;

Paramètres

properties
Word.DocumentProperties

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.DocumentProperties est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DocumentPropertiesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.DocumentPropertiesData;

Retours

Word.Interfaces.DocumentPropertiesData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.DocumentProperties;

Retours

Word.DocumentProperties

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.DocumentProperties;

Retours

Word.DocumentProperties