Word.Interfaces.FieldLoadOptions interface
Représente un champ.
Remarques
[ Ensemble d’API : WordApi 1.4 ]
Important : pour en savoir plus sur les champs qui peuvent ê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 à 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 |
code | Spécifie l’instruction de code du champ. |
data | Spécifie les données d’un champ « Addin ». Si le champ n’est pas un champ « Addin », il l’est |
kind | Obtient le type du champ. |
locked | Spécifie si le champ est verrouillé.
|
parent |
Obtient le corps parent du champ. |
parent |
Obtient le contrôle de contenu qui contient le champ. Génère une |
parent |
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 |
parent |
Obtient la table qui contient le champ. Génère une |
parent |
Obtient la cellule de tableau qui contient le champ. Génère une |
parent |
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 |
parent |
Obtient la table qui contient le champ. Si elle n’est pas contenue dans une table, cette méthode retourne un objet avec sa |
result | Obtient les données de résultat du champ. |
show |
Spécifie si les codes de champ sont affichés pour le champ spécifié.
|
type | 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
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
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
kind
Obtient le type du champ.
kind?: boolean;
Valeur de propriété
boolean
Remarques
locked
Spécifie si le champ est verrouillé.
true
si le champ est verrouillé, false
sinon.
locked?: boolean;
Valeur de propriété
boolean
Remarques
parentBody
Obtient le corps parent du champ.
parentBody?: Word.Interfaces.BodyLoadOptions;
Valeur de propriété
Remarques
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
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 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é
Remarques
parentTable
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é
Remarques
parentTableCell
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é
Remarques
parentTableCellOrNullObject
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é
Remarques
parentTableOrNullObject
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é
Remarques
result
Obtient les données de résultat du champ.
result?: Word.Interfaces.RangeLoadOptions;
Valeur de propriété
Remarques
showCodes
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
type
Obtient le type du champ.
type?: boolean;
Valeur de propriété
boolean