Word.ListTemplateGalleryCollection class
Contient une collection de Word. ListTemplateGallery disponibles via les trois boutons à puces et numérotation sous l’onglet Accueil (voir Définir de nouvelles puces, numéros et listes à plusieurs niveaux pour savoir comment y accéder dans l’interface utilisateur de Word).
- Extends
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| get |
Obtient un |
| get |
Obtient un |
| get |
Récupère un |
| 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 |
| track() | Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des |
| untrack() | Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Word.ListTemplateGallery[];Valeur de propriété
Détails de la méthode
getByType(type)
Obtient un ListTemplateGallery objet par son type dans la collection.
getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery;Paramètres
Le type de galerie de modèles de liste à récupérer.
Retours
Remarques
getByType(type)
Obtient un ListTemplateGallery objet par son type dans la collection.
getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery;Paramètres
- type
-
"Bullets" | "Number" | "OutlineNumbered"
Le type de galerie de modèles de liste à récupérer.
Retours
Remarques
getItem(index)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Récupère un ListTemplateGallery objet par son index dans la collection.
getItem(index: number): Word.ListTemplateGallery;Paramètres
- index
-
number
Emplacement d’un ListTemplateGallery objet.
Retours
Remarques
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[]): Word.ListTemplateGalleryCollection;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant 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?: OfficeExtension.LoadOption): Word.ListTemplateGalleryCollection;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
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 Word.ListTemplateGalleryCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.ListTemplateGalleryCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData;Retours
track()
Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
track(): Word.ListTemplateGalleryCollection;Retours
untrack()
Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.
untrack(): Word.ListTemplateGalleryCollection;