Excel.CustomProperty class

Paquet:

excel

Représente une propriété personnalisée.

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.
key	Clé de la propriété personnalisée. 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).
type	Type de la valeur utilisée pour la propriété personnalisée.
value	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).

Méthodes

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

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

key

Clé de la propriété personnalisée. 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).

readonly key: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

type

Type de la valeur utilisée pour la propriété personnalisée.

readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float";

Valeur de propriété

Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

value

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

value: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Détails de la méthode

delete()

Supprime la propriété personnalisée.

delete(): void;

Retours

void

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

Paramètres

options

Excel.Interfaces.CustomPropertyLoadOptions

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

Retours

Excel.CustomProperty

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

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

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

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

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.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.CustomPropertyUpdateData

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.CustomProperty): void;

Paramètres

properties

Excel.CustomProperty

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

toJSON(): Excel.Interfaces.CustomPropertyData;

Retours

Excel.Interfaces.CustomPropertyData