Partager via


Word.CustomXmlSchemaCollection class

Représente une collection de Word. Objets CustomXmlSchema attachés à un flux de données.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

add(options)

Ajoute un ou plusieurs schémas à la collection de schémas qui peuvent ensuite être ajoutés à un flux dans le magasin de données et à la bibliothèque de schémas.

addCollection(schemaCollection)

Cette méthode ajoute une collection de schémas existante à la collection de schémas active.

getCount()

Retourne le nombre d’éléments de la collection.

getItem(index)

Renvoie un CustomXmlSchema objet qui représente l’élément spécifié dans la collection.

getNamespaceUri()

Retourne le nombre d’éléments de la collection.

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.

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.CustomXmlSchemaCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.CustomXmlSchemaCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

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.

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.

validate()

Spécifie si les schémas de la collection de schémas sont valides (conforme aux règles syntaxiques de XML et aux règles d’un vocabulaire spécifié).

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.CustomXmlSchema[];

Valeur de propriété

Détails de la méthode

add(options)

Ajoute un ou plusieurs schémas à la collection de schémas qui peuvent ensuite être ajoutés à un flux dans le magasin de données et à la bibliothèque de schémas.

add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema;

Paramètres

options
Word.CustomXmlAddSchemaOptions

Facultatif. Options qui définissent le schéma à ajouter.

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

addCollection(schemaCollection)

Cette méthode ajoute une collection de schémas existante à la collection de schémas active.

addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection;

Paramètres

schemaCollection
Word.CustomXmlSchemaCollection

Collection de schémas à ajouter.

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

getCount()

Retourne le nombre d’éléments de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

getItem(index)

Renvoie un CustomXmlSchema objet qui représente l’élément spécifié dans la collection.

getItem(index: number): Word.CustomXmlSchema;

Paramètres

index

number

Emplacement d’un CustomXmlSchema objet.

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

getNamespaceUri()

Retourne le nombre d’éléments de la collection.

getNamespaceUri(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection;

Paramètres

options

Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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

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

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.CustomXmlSchemaCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.CustomXmlSchemaCollectionDataque ) 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.CustomXmlSchemaCollectionData;

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

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

Retours

validate()

Spécifie si les schémas de la collection de schémas sont valides (conforme aux règles syntaxiques de XML et aux règles d’un vocabulaire spécifié).

validate(): OfficeExtension.ClientResult<boolean>;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]