Word.ShapeCollection class
Contient une collection de Word. Objets Shape. Actuellement, seules les formes suivantes sont prises en charge : zones de texte, formes géométriques, groupes, images et canevas.
- Extends
Remarques
[ Ensemble d’API : WordApiDesktop 1.2 ]
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
| get |
Obtient les formes qui ont les types géométriques spécifiés. Appliqué uniquement aux formes géométriques. |
| get |
Obtient une forme par son identificateur. Génère une |
| get |
Obtient une forme par son identificateur. S’il n’existe pas de forme avec l’identificateur dans cette collection, cette méthode retourne un objet avec sa |
| get |
Obtient les formes en fonction des identificateurs. |
| get |
Obtient les formes qui ont les noms spécifiés. |
| get |
Obtient les formes qui ont les types spécifiés. |
| get |
Obtient la première forme de cette collection. Génère une |
| get |
Obtient la première forme de cette collection. Si cette collection est vide, cette méthode retourne un objet avec sa |
| group() | Groupes de formes flottantes dans cette collection, les formes inline seront ignorées. Renvoie un objet Shape qui représente la nouvelle forme. |
| 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 |
| 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 sur des |
| untrack() | Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 . Cela connecte le processus du complément au processus 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.Shape[];Valeur de propriété
Détails de la méthode
getByGeometricTypes(types)
Obtient les formes qui ont les types géométriques spécifiés. Appliqué uniquement aux formes géométriques.
getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection;Paramètres
- types
Obligatoire. Tableau de sous-types de formes géométriques.
Retours
Remarques
getById(id)
Obtient une forme par son identificateur. Génère une ItemNotFound erreur s’il n’existe pas de forme avec l’identificateur dans cette collection.
getById(id: number): Word.Shape;Paramètres
- id
-
number
Obligatoire. Identificateur de forme.
Retours
Remarques
getByIdOrNullObject(id)
Obtient une forme par son identificateur. S’il n’existe pas de forme avec l’identificateur dans cette collection, 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.
getByIdOrNullObject(id: number): Word.Shape;Paramètres
- id
-
number
Obligatoire. Identificateur de forme.
Retours
Remarques
getByIds(ids)
Obtient les formes en fonction des identificateurs.
getByIds(ids: number[]): Word.ShapeCollection;Paramètres
- ids
-
number[]
Obligatoire. Tableau d’identificateurs de forme.
Retours
Remarques
getByNames(names)
Obtient les formes qui ont les noms spécifiés.
getByNames(names: string[]): Word.ShapeCollection;Paramètres
- names
-
string[]
Obligatoire. Tableau de noms de formes.
Retours
Remarques
getByTypes(types)
Obtient les formes qui ont les types spécifiés.
getByTypes(types: Word.ShapeType[]): Word.ShapeCollection;Paramètres
- types
Obligatoire. Tableau de types de formes.
Retours
Remarques
getFirst()
Obtient la première forme de cette collection. Génère une ItemNotFound erreur si cette collection est vide.
getFirst(): Word.Shape;Retours
Remarques
getFirstOrNullObject()
Obtient la première forme de cette collection. Si cette collection est vide, 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.
getFirstOrNullObject(): Word.Shape;Retours
Remarques
group()
Groupes de formes flottantes dans cette collection, les formes inline seront ignorées. Renvoie un objet Shape qui représente la nouvelle forme.
group(): Word.Shape;Retours
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?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection;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[]): Word.ShapeCollection;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?: OfficeExtension.LoadOption): Word.ShapeCollection;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.ShapeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ShapeCollectionDataque ) 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(): Word.Interfaces.ShapeCollectionData;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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
track(): Word.ShapeCollection;Retours
untrack()
Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.
untrack(): Word.ShapeCollection;