Word.Interfaces.FieldCollectionLoadOptions interface

Paquet:

word

Contient une collection de Word. Objets de champ.

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Important : pour en savoir plus sur les champs qui peuvent être insérés, consultez le introduit dans l’ensemble Word.Range.insertField API de conditions requises 1.5. La prise en charge de la gestion des champs est similaire à ce qui est disponible dans l’interface utilisateur Word. Toutefois, alors que l’interface utilisateur Word sur le web prend principalement en charge les champs en lecture seule (voir Codes de champ dans Word pour le web), le Addin champ est modifiable. Pour en savoir plus sur Word clients d’interface utilisateur qui prennent plus en charge les champs, consultez la liste des produits au début de l’article Insérer, modifier et afficher des champs dans Word.

Propriétés

$all	La spécification des options de $all chargement charge toutes les propriétés scalaires (telles que Range.address) mais pas les propriétés de navigation (telles que Range.format.fill.color).
code	Pour CHAQUE ÉLÉMENT de la collection : spécifie l’instruction de code du champ.
data	Pour CHAQUE ÉLÉMENT de la collection : spécifie les données d’un champ « Addin ». Si le champ n’est pas un champ « Addin », il l’est null et il lève une exception générale lorsque le code tente de le définir.
kind	Pour CHAQUE ÉLÉMENT de la collection : obtient le type du champ.
locked	Pour CHAQUE ÉLÉMENT de la collection : spécifie si le champ est verrouillé. true si le champ est verrouillé, false sinon.
parentBody	Pour CHAQUE ÉLÉMENT de la collection : obtient le corps parent du champ.
parentContentControl	Pour CHAQUE ÉLÉMENT de la collection : obtient le contrôle de contenu qui contient le champ. Génère une ItemNotFound erreur s’il n’existe pas de contrôle de contenu parent.
parentContentControlOrNullObject	Pour CHAQUE ÉLÉMENT de la collection : obtient le contrôle de contenu qui contient le champ. S’il n’existe pas de contrôle de contenu parent, 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.
parentTable	Pour CHAQUE ÉLÉMENT de la collection : obtient la table qui contient le champ. Génère une ItemNotFound erreur si elle n’est pas contenue dans une table.
parentTableCell	Pour CHAQUE ÉLÉMENT de la collection : obtient la cellule de tableau qui contient le champ. Génère une ItemNotFound erreur si elle n’est pas contenue dans une cellule de tableau.
parentTableCellOrNullObject	Pour CHAQUE ÉLÉMENT de la collection : obtient la cellule de tableau qui contient le champ. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
parentTableOrNullObject	Pour CHAQUE ÉLÉMENT de la collection : obtient la table qui contient le champ. Si elle n’est pas contenue dans une table, 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.
result	Pour CHAQUE ÉLÉMENT de la collection : obtient les données de résultat du champ.
showCodes	Pour CHAQUE ÉLÉMENT de la collection : spécifie si les codes de champ sont affichés pour le champ spécifié. true si les codes de champ sont affichés, false sinon.
type	Pour CHAQUE ÉLÉMENT de la collection : obtient le type du champ.

Détails de la propriété

$all

La spécification des options de $all chargement charge toutes les propriétés scalaires (telles que Range.address) mais pas les propriétés de navigation (telles que Range.format.fill.color).

$all?: boolean;

Valeur de propriété

boolean

code

Pour CHAQUE ÉLÉMENT de la collection : spécifie l’instruction de code du champ.

code?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Remarque : La possibilité de définir le code a été introduite dans WordApi 1.5.

data

Pour CHAQUE ÉLÉMENT de la collection : spécifie les données d’un champ « Addin ». Si le champ n’est pas un champ « Addin », il l’est null et il lève une exception générale lorsque le code tente de le définir.

data?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

kind

Pour CHAQUE ÉLÉMENT de la collection : obtient le type du champ.

kind?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

locked

Pour CHAQUE ÉLÉMENT de la collection : spécifie si le champ est verrouillé. true si le champ est verrouillé, false sinon.

locked?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]

parentBody

Pour CHAQUE ÉLÉMENT de la collection : obtient le corps parent du champ.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valeur de propriété

Word.Interfaces.BodyLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

parentContentControl

Pour CHAQUE ÉLÉMENT de la collection : obtient le contrôle de contenu qui contient le champ. Génère une ItemNotFound erreur s’il n’existe pas de contrôle de contenu parent.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valeur de propriété

Word.Interfaces.ContentControlLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

parentContentControlOrNullObject

Pour CHAQUE ÉLÉMENT de la collection : obtient le contrôle de contenu qui contient le champ. S’il n’existe pas de contrôle de contenu parent, 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.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Valeur de propriété

Word.Interfaces.ContentControlLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

parentTable

Pour CHAQUE ÉLÉMENT de la collection : obtient la table qui contient le champ. Génère une ItemNotFound erreur si elle n’est pas contenue dans une table.

parentTable?: Word.Interfaces.TableLoadOptions;

Valeur de propriété

Word.Interfaces.TableLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

parentTableCell

Pour CHAQUE ÉLÉMENT de la collection : obtient la cellule de tableau qui contient le champ. Génère une ItemNotFound erreur si elle n’est pas contenue dans une cellule de tableau.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valeur de propriété

Word.Interfaces.TableCellLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

parentTableCellOrNullObject

Pour CHAQUE ÉLÉMENT de la collection : obtient la cellule de tableau qui contient le champ. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valeur de propriété

Word.Interfaces.TableCellLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

parentTableOrNullObject

Pour CHAQUE ÉLÉMENT de la collection : obtient la table qui contient le champ. Si elle n’est pas contenue dans une table, 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.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valeur de propriété

Word.Interfaces.TableLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

result

Pour CHAQUE ÉLÉMENT de la collection : obtient les données de résultat du champ.

result?: Word.Interfaces.RangeLoadOptions;

Valeur de propriété

Word.Interfaces.RangeLoadOptions

Remarques

[ Ensemble d’API : WordApi 1.4 ]

showCodes

Pour CHAQUE ÉLÉMENT de la collection : spécifie si les codes de champ sont affichés pour le champ spécifié. true si les codes de champ sont affichés, false sinon.

showCodes?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

type

Pour CHAQUE ÉLÉMENT de la collection : obtient le type du champ.

type?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.5 ]