Partager via


Word.TableOfAuthoritiesCollection class

Représente une collection de Word. Objets TableOfAuthorities dans un document Word.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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(range, options)

Ajoute une table de références au document à la plage spécifiée.

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.

markAllCitations(shortCitation, options)

Insère un champ Entrée de table des références (TA) après toutes les instances du texte de citation spécifié.

markCitation(range, shortCitation, options)

Insère un champ Entrée de table des références (TA) dans la plage spécifiée.

selectNextCitation(shortCitation)

Recherche et sélectionne le instance suivant du texte de citation spécifié.

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

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

Valeur de propriété

Détails de la méthode

add(range, options)

Ajoute une table de références au document à la plage spécifiée.

add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities;

Paramètres

range
Word.Range

Plage dans laquelle la table des références apparaîtra. La table de références remplace la plage si la plage n’est pas réduite.

options
Word.TableOfAuthoritiesAddOptions

Facultatif. Options permettant de configurer la table des autorités.

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

Paramètres

options

Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & 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.TableOfAuthoritiesCollection;

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

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

markAllCitations(shortCitation, options)

Insère un champ Entrée de table des références (TA) après toutes les instances du texte de citation spécifié.

markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void;

Paramètres

shortCitation

string

Texte de citation à marquer.

options
Word.TableOfAuthoritiesMarkCitationOptions

Facultatif. Options permettant de marquer la citation.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

markCitation(range, shortCitation, options)

Insère un champ Entrée de table des références (TA) dans la plage spécifiée.

markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field;

Paramètres

range
Word.Range

Plage dans laquelle la citation sera insérée.

shortCitation

string

Texte de citation court.

options
Word.TableOfAuthoritiesMarkCitationOptions

Facultatif. Options permettant de marquer la citation.

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

selectNextCitation(shortCitation)

Recherche et sélectionne le instance suivant du texte de citation spécifié.

selectNextCitation(shortCitation: string): void;

Paramètres

shortCitation

string

Texte de citation à rechercher.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

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

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

Retours