Excel.DocumentProperties class

  • Référence
Paquet:
excel

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

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

author

Auteur du classeur.
category

Catégorie du classeur.
comments

Commentaires du classeur.
company

Société du classeur.
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 classeur.
custom

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

Mots clés du classeur.
lastAuthor

Obtient ou définit le dernier auteur du classeur.
manager

Gestionnaire du classeur.
revisionNumber

Obtient le numéro de révision du classeur.
subject

Objet du classeur.
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 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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.DocumentProperties d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.DocumentPropertiesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

author

Auteur du classeur.

author: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

category

Catégorie du classeur.

category: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

comments

Commentaires du classeur.

comments: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

company

Société du classeur.

company: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Excel.RequestContext

creationDate

Obtient la date de création du classeur.

readonly creationDate: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

custom

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

readonly custom: Excel.CustomPropertyCollection;

Valeur de propriété

Excel.CustomPropertyCollection

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

Mots clés du classeur.

keywords: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

lastAuthor

Obtient ou définit le dernier auteur du classeur.

readonly lastAuthor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

manager

Gestionnaire du classeur.

manager: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

revisionNumber

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

revisionNumber: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

subject

Objet du classeur.

subject: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

title

Titre du classeur.

title: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

options
Excel.Interfaces.DocumentPropertiesLoadOptions

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

Retours

Excel.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[]): Excel.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

Excel.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;
        }): 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

Excel.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
Excel.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: 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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.DocumentProperties d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.DocumentPropertiesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.DocumentPropertiesData;

Retours

Excel.Interfaces.DocumentPropertiesData