Excel.DocumentProperties class
Représente les propriétés du classeur.
- Extends
Propriétés
| author | L’auteur du classeur. |
| category | Catégorie du classeur. |
| comments | Le champ Commentaires dans les métadonnées du classeur. Ceux-ci n’ont aucun lien avec les commentaires des utilisateurs effectués dans le classeur. |
| company | Compagnie du classeur. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| creation |
Obtient la date de création du classeur. |
| custom | Obtient la collection de propriétés personnalisées du classeur. |
| keywords | Les mots clés du classeur. |
| last |
Obtient ou définit le dernier auteur du classeur. |
| manager | Le responsable du classeur. |
| revision |
Obtient le numéro de révision du classeur. |
| subject | Sujet du cahier d’exercices. |
| title | Titre du classeur. |
Méthodes
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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 |
Détails de la propriété
author
category
Catégorie du classeur.
category: string;Valeur de propriété
string
Remarques
comments
Le champ Commentaires dans les métadonnées du classeur. Ceux-ci n’ont aucun lien avec les commentaires des utilisateurs effectués dans le classeur.
comments: string;Valeur de propriété
string
Remarques
company
Compagnie du classeur.
company: string;Valeur de propriété
string
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
creationDate
Obtient la date de création du classeur.
readonly creationDate: Date;Valeur de propriété
Date
Remarques
custom
Obtient la collection de propriétés personnalisées du classeur.
readonly custom: Excel.CustomPropertyCollection;Valeur de propriété
Remarques
Exemples
// 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
Les mots clés du classeur.
keywords: string;Valeur de propriété
string
Remarques
lastAuthor
Obtient ou définit le dernier auteur du classeur.
readonly lastAuthor: string;Valeur de propriété
string
Remarques
manager
Le responsable du classeur.
manager: string;Valeur de propriété
string
Remarques
revisionNumber
Obtient le numéro de révision du classeur.
revisionNumber: number;Valeur de propriété
number
Remarques
subject
Sujet du cahier d’exercices.
subject: string;Valeur de propriété
string
Remarques
title
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?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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[]): Excel.DocumentProperties;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
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;
}): Excel.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
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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: Excel.DocumentProperties): void;Paramètres
- properties
- Excel.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 Excel.DocumentProperties est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.DocumentPropertiesDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.DocumentPropertiesData;