PowerPoint.CustomPropertyCollection class
Collection de propriétés personnalisées.
- S' étend
Remarques
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éthode
| add(key, value) | Crée ou |
| delete |
Supprime toutes les propriétés personnalisées de cette collection. |
| get |
Obtient le nombre de propriétés personnalisées dans la collection. |
| get |
Obtient un |
| get |
Obtient un |
| get |
Obtient un |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
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 la propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: PowerPoint.CustomProperty[];Valeur de la propriété
Détails de la méthode
add(key, value)
Crée ou CustomProperty met à jour la propriété avec la clé donnée.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Paramètres
- key
-
string
Chaîne qui identifie l’objet CustomProperty . Il ne respecte pas la casse. La longueur maximale de la clé est de 255 caractères. Les chaînes plus volumineuses entraînent l’échec de l’opération avec une InvalidArgument erreur.
- value
-
boolean | Date | number | string
Valeur de .CustomProperty Si la valeur est une chaîne, la longueur maximale est de 255 caractères. Les chaînes plus volumineuses entraînent l’échec de l’opération avec une InvalidArgument erreur.
Retourne
Remarques
deleteAll()
Supprime toutes les propriétés personnalisées de cette collection.
deleteAll(): void;Retourne
void
Remarques
getCount()
Obtient le nombre de propriétés personnalisées dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retourne
OfficeExtension.ClientResult<number>
Nombre de propriétés personnalisées dans la collection.
Remarques
getItem(key)
Obtient un CustomProperty par sa clé.
getItem(key: string): PowerPoint.CustomProperty;Paramètres
- key
-
string
Chaîne qui identifie l’objet CustomProperty . Il ne respecte pas la casse. La longueur maximale des clés est de 255 caractères. Si l’argument dépasse 255 caractères, cette méthode retourne l’erreur InvalidArgument .
Retourne
Remarques
getItemAt(index)
Obtient un CustomProperty par son index de base zéro dans la collection. Lève une InvalidArgument exception lorsque l’index est hors limites.
getItemAt(index: number): PowerPoint.CustomProperty;Paramètres
- index
-
number
Index de la propriété personnalisée dans la collection.
Retourne
Propriété personnalisée à l’index donné.
Remarques
getItemOrNullObject(key)
Obtient un CustomProperty par sa clé. Si n’existe CustomProperty 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): PowerPoint.CustomProperty;Paramètres
- key
-
string
Chaîne qui identifie l’objet CustomProperty . Il ne respecte pas la casse. La longueur maximale des clés est de 255 caractères. Si l’argument dépasse 255 caractères, cette méthode retourne l’erreur InvalidArgument .
Retourne
Remarques
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?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;Paramètres
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retourne
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[]): PowerPoint.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.
Retourne
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): PowerPoint.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.
Retourne
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.CustomPropertyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.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(): PowerPoint.Interfaces.CustomPropertyCollectionData;