Word.TableOfAuthorities class
Représente une table de références dans un document Word.
- Extends
Remarques
Propriétés
| bookmark | Spécifie le nom du signet à partir duquel collecter les entrées de table de références. |
| category | Spécifie la catégorie d’entrées à inclure dans la table des références. Les valeurs 0 à 16 correspondent aux éléments répertoriés dans la zone Catégorie de la boîte de dialogue Table des références. Pour savoir comment y accéder via l’interface utilisateur Word, consultez Créer une table de références. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| entry |
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre l’entrée de la table des références et son numéro de page. |
| is |
Spécifie si le nom de catégorie d’un groupe d’entrées apparaît dans la table des références. |
| is |
Spécifie si les entrées de la table des références sont affichées avec leur mise en forme dans le tableau. |
| is |
Spécifie si les références à la même autorité qui sont répétées sur cinq pages ou plus sont remplacées par « Passim ». |
| page |
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre les références de page individuelles dans la table des références. |
| page |
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre les plages de pages dans la table des références. |
| range | Obtient la partie d’un document qui correspond à cette table de références. |
| sequence |
Spécifie l’identificateur de champ Sequence (SEQ) pour la table de références. |
| sequence |
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre le numéro de séquence et le numéro de page dans la table des références. |
| tab |
Spécifie le caractère de début qui apparaît entre les entrées et les numéros de page associés dans la table des autorités. |
Méthodes
| delete() | Supprime cette table de références. |
| 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 |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| 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é
bookmark
Spécifie le nom du signet à partir duquel collecter les entrées de table de références.
bookmark: string;
Valeur de propriété
string
Remarques
category
Spécifie la catégorie d’entrées à inclure dans la table des références. Les valeurs 0 à 16 correspondent aux éléments répertoriés dans la zone Catégorie de la boîte de dialogue Table des références. Pour savoir comment y accéder via l’interface utilisateur Word, consultez Créer une table de références.
category: number;
Valeur de propriété
number
Remarques
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é
entrySeparator
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre l’entrée de la table des références et son numéro de page.
entrySeparator: string;
Valeur de propriété
string
Remarques
isCategoryHeaderIncluded
Spécifie si le nom de catégorie d’un groupe d’entrées apparaît dans la table des références.
isCategoryHeaderIncluded: boolean;
Valeur de propriété
boolean
Remarques
isEntryFormattingKept
Spécifie si les entrées de la table des références sont affichées avec leur mise en forme dans le tableau.
isEntryFormattingKept: boolean;
Valeur de propriété
boolean
Remarques
isPassimUsed
Spécifie si les références à la même autorité qui sont répétées sur cinq pages ou plus sont remplacées par « Passim ».
isPassimUsed: boolean;
Valeur de propriété
boolean
Remarques
pageNumberSeparator
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre les références de page individuelles dans la table des références.
pageNumberSeparator: string;
Valeur de propriété
string
Remarques
pageRangeSeparator
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre les plages de pages dans la table des références.
pageRangeSeparator: string;
Valeur de propriété
string
Remarques
range
Obtient la partie d’un document qui correspond à cette table de références.
readonly range: Word.Range;
Valeur de propriété
Remarques
sequenceName
Spécifie l’identificateur de champ Sequence (SEQ) pour la table de références.
sequenceName: string;
Valeur de propriété
string
Remarques
sequenceSeparator
Spécifie un séparateur de cinq caractères maximum. Cela apparaît entre le numéro de séquence et le numéro de page dans la table des références.
sequenceSeparator: string;
Valeur de propriété
string
Remarques
tabLeader
Spécifie le caractère de début qui apparaît entre les entrées et les numéros de page associés dans la table des autorités.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";
Valeur de propriété
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Remarques
Détails de la méthode
delete()
Supprime cette table de références.
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?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;
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.TableOfAuthorities;
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;
}): Word.TableOfAuthorities;
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
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
- properties
- Word.Interfaces.TableOfAuthoritiesUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Word.TableOfAuthorities): void;
Paramètres
- properties
- Word.TableOfAuthorities
Retours
void
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.TableOfAuthorities est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableOfAuthoritiesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Word.Interfaces.TableOfAuthoritiesData;
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.TableOfAuthorities;
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.TableOfAuthorities;