Excel.DocumentProperties class

Auteur du classeur.

author: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Catégorie du classeur.

category: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Champ Commentaires dans les métadonnées du classeur. Celles-ci n’ont aucun lien avec les commentaires des utilisateurs effectués dans le document de travail.

comments: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Société du classeur.

company: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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é

Obtient la date de création du classeur.

readonly creationDate: Date;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

readonly custom: Excel.CustomPropertyCollection;

Valeur de propriété

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

Mots clés du classeur.

keywords: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Obtient ou définit le dernier auteur du classeur.

readonly lastAuthor: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Gestionnaire du classeur.

manager: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

revisionNumber: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Objet du classeur.

subject: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Titre du classeur.

title: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

toJSON(): Excel.Interfaces.DocumentPropertiesData;

Retours