PowerPoint.CustomProperty class
Représente une propriété personnalisée.
- Extends
Remarques
[ Ensemble d’API : PowerPointApi 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 | Chaîne qui identifie de façon unique la propriété personnalisée. |
| type | Type de la valeur utilisée pour la propriété personnalisée. |
| value | Valeur de la propriété personnalisée. 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 |
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 |
| 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 propriété
key
Chaîne qui identifie de façon unique la propriété personnalisée.
readonly key: string;Valeur de propriété
string
Remarques
type
Type de la valeur utilisée pour la propriété personnalisée.
readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";Valeur de propriété
PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"
Remarques
value
Valeur de la propriété personnalisée. 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.
value: boolean | Date | number | string;Valeur de propriété
boolean | Date | number | string
Remarques
Détails de la méthode
delete()
Supprime la propriété personnalisée.
delete(): void;Retours
void
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.CustomPropertyLoadOptions): PowerPoint.CustomProperty;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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.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
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;
}): PowerPoint.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
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.CustomProperty est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.CustomPropertyDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): PowerPoint.Interfaces.CustomPropertyData;