Excel.CustomPropertyCollection class

  • Référence
Paquet:
excel

Contient la collection de propriétés personnalisées.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Propriétés

context

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

Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(key, value)

Crée une nouvelle propriété personnalisée ou en définit une existante.
deleteAll()

Supprime toutes les propriétés personnalisées de cette collection.
getCount()

Obtient le nombre des propriétés personnalisées.
getItem(key)

Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Génère une erreur si la propriété personnalisée n’existe pas.
getItemOrNullObject(key)

Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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.
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 d’origine Excel.CustomPropertyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.CustomPropertyCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

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

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.CustomProperty[];

Valeur de propriété

Excel.CustomProperty[]

Détails de la méthode

add(key, value)

Crée une nouvelle propriété personnalisée ou en définit une existante.

add(key: string, value: any): Excel.CustomProperty;

Paramètres

key

string

Obligatoire. Clé de la propriété personnalisée, qui ne respecte pas la casse. La clé est limitée à 255 caractères en dehors de Excel sur le Web (les touches plus grandes sont automatiquement réduites à 255 caractères sur d’autres plateformes).

value

any

Obligatoire. Valeur de la propriété personnalisée. La valeur est limitée à 255 caractères en dehors de Excel sur le Web (les valeurs plus grandes sont automatiquement réduites à 255 caractères sur d’autres plateformes).

Retours

Excel.CustomProperty

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) => {
  // Get the key/value pair from the task pane.
  const userKey = $("#key").text();
  const userValue = $("#value").text();

  // Add the custom property.
  const customDocProperties = context.workbook.properties.custom;
  customDocProperties.add(userKey, userValue);

  await context.sync();

  console.log(`Successfully set custom document property ${userKey}:${userValue}.`);
});

deleteAll()

Supprime toutes les propriétés personnalisées de cette collection.

deleteAll(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

getCount()

Obtient le nombre des propriétés personnalisées.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

getItem(key)

Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Génère une erreur si la propriété personnalisée n’existe pas.

getItem(key: string): Excel.CustomProperty;

Paramètres

key

string

Clé qui identifie l’objet de propriété personnalisé.

Retours

Excel.CustomProperty

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

getItemOrNullObject(key)

Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(key: string): Excel.CustomProperty;

Paramètres

key

string

Obligatoire. Clé qui identifie l’objet de propriété personnalisé.

Retours

Excel.CustomProperty

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;

Paramètres

options

Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.CustomPropertyCollection

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.CustomPropertyCollection;

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.CustomPropertyCollection

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?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection;

Paramètres

propertyNamesAndPaths
OfficeExtension.LoadOption

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.CustomPropertyCollection

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 d’origine Excel.CustomPropertyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.CustomPropertyCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.CustomPropertyCollectionData;

Retours

Excel.Interfaces.CustomPropertyCollectionData