Excel.WorksheetCustomPropertyCollection class

  • Référence
Paquet:
excel

Contient la collection de propriétés personnalisées au niveau de la feuille de calcul.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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)

Ajoute une nouvelle propriété personnalisée qui correspond à la clé fournie. Cette opération remplace les propriétés personnalisées existantes par cette clé.
getCount()

Obtient le nombre de propriétés personnalisées dans cette feuille de calcul.
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.WorksheetCustomPropertyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorksheetCustomPropertyCollectionDataque ) 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.WorksheetCustomProperty[];

Valeur de propriété

Excel.WorksheetCustomProperty[]

Détails de la méthode

add(key, value)

Ajoute une nouvelle propriété personnalisée qui correspond à la clé fournie. Cette opération remplace les propriétés personnalisées existantes par cette clé.

add(key: string, value: string): Excel.WorksheetCustomProperty;

Paramètres

key

string

Clé qui identifie l’objet de propriété personnalisé. Il ne respecte pas la casse. La clé est limitée à 255 caractères (des valeurs plus grandes entraînent la levée d’une InvalidArgument erreur.)

value

string

Valeur de cette propriété personnalisée.

Retours

Excel.WorksheetCustomProperty

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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 customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.add(userKey, userValue);

  await context.sync();

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

getCount()

Obtient le nombre de propriétés personnalisées dans cette feuille de calcul.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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

Paramètres

key

string

Clé qui identifie l’objet de propriété personnalisé. Il ne respecte pas la casse.

Retours

Excel.WorksheetCustomProperty

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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

Paramètres

key

string

Clé qui identifie l’objet de propriété personnalisé. Il ne respecte pas la casse.

Retours

Excel.WorksheetCustomProperty

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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

Paramètres

options

Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.WorksheetCustomPropertyCollection

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

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

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

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

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.WorksheetCustomPropertyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorksheetCustomPropertyCollectionDataque ) 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.WorksheetCustomPropertyCollectionData;

Retours

Excel.Interfaces.WorksheetCustomPropertyCollectionData