Word.Interfaces.FieldLoadOptions interface

Représente un champ.

Remarques

Jeu d’API : WordApi 1.4

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

Utilisateur

Propriétés

$all

La spécification $all des options de 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

Spécifie l’instruction de code du champ.

data

Spécifie les données dans un champ de addin type. Si le champ n’est pas un addin type, il l’est null et il lève une exception générale lorsque le code tente de le définir.

kind

Obtient le genre du terrain.

linkFormat

Obtient un LinkFormat objet qui représente les options de liaison du champ.

locked

Indique si le champ est verrouillé. true Dans le cas contraire, false si le champ est verrouillé.

oleFormat

Obtient un OleFormat objet qui représente les caractéristiques OLE (autres que la liaison) pour le champ.

parentBody

Récupère le corps parent du champ.

parentContentControl

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

Obtient le contrôle de contenu qui contient le champ. S’il n’existe pas de contrôle de contenu parent, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

parentTable

Permet d’obtenir la table qui contient le champ. Génère une ItemNotFound erreur si elle n’est pas contenue dans une table.

parentTableCell

Obtient la cellule de la table qui contient le champ. Génère une ItemNotFound erreur si elle n’est pas contenue dans une cellule de tableau.

parentTableCellOrNullObject

Obtient la cellule de la table qui contient le champ. S’il n’est pas contenu 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 d’OrNullObject.

parentTableOrNullObject

Permet d’obtenir la table qui contient le champ. S’il n’est pas contenu dans une table, 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 d’OrNullObject.

result

Extrait les données de résultat du champ.

showCodes

Indique si les codes de champ sont affichés pour le champ spécifié. true Dans le cas contraire, false si les codes de champ sont affichés.

type

Récupère le type du champ.

Détails de la propriété

$all

La spécification $all des options de 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

Spécifie l’instruction de code du champ.

code?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.4

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

data

Spécifie les données dans un champ de addin type. Si le champ n’est pas un addin type, 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

Jeu d’API : WordApi 1.5

kind

Obtient le genre du terrain.

kind?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.5

linkFormat

Obtient un LinkFormat objet qui représente les options de liaison du champ.

linkFormat?: Word.Interfaces.LinkFormatLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

locked

Indique si le champ est verrouillé. true Dans le cas contraire, false si le champ est verrouillé.

locked?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.5

oleFormat

Obtient un OleFormat objet qui représente les caractéristiques OLE (autres que la liaison) pour le champ.

oleFormat?: Word.Interfaces.OleFormatLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

parentBody

Récupère le corps parent du champ.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

parentContentControl

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é

Remarques

Jeu d’API : WordApi 1.4

parentContentControlOrNullObject

Obtient le contrôle de contenu qui contient le champ. S’il n’existe pas de contrôle de contenu parent, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

parentTable

Permet d’obtenir 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é

Remarques

Jeu d’API : WordApi 1.4

parentTableCell

Obtient la cellule de la table 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é

Remarques

Jeu d’API : WordApi 1.4

parentTableCellOrNullObject

Obtient la cellule de la table qui contient le champ. S’il n’est pas contenu 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 d’OrNullObject.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

parentTableOrNullObject

Permet d’obtenir la table qui contient le champ. S’il n’est pas contenu dans une table, 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 d’OrNullObject.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

result

Extrait les données de résultat du champ.

result?: Word.Interfaces.RangeLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.4

showCodes

Indique si les codes de champ sont affichés pour le champ spécifié. true Dans le cas contraire, false si les codes de champ sont affichés.

showCodes?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.1

type

Récupère le type du champ.

type?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.5