Word.Field class
Représente un champ.
- Extends
Remarques
[ Ensemble d’API : WordApi 1.4 ]
Important : pour en savoir plus sur les champs qui peuvent être insérés, consultez la Word. API Range.insertField introduite dans l’ensemble 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
| code | Spécifie l’instruction de code du champ. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| 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. |
Méthodes
| get |
Obtient le champ suivant. Génère une |
| get |
Obtient le champ suivant. Si ce champ est le dernier, cette méthode retourne un objet avec sa |
| 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é
code
Spécifie l’instruction de code du champ.
code: string;Valeur de propriété
string
Remarques
[ Ensemble d’API : WordApi 1.4 ]
Remarque : La possibilité de définir le code a été introduite dans WordApi 1.5.
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml
// Gets the first field in the document.
await Word.run(async (context) => {
const field = context.document.body.fields.getFirstOrNullObject();
field.load(["code", "result", "locked", "type", "data", "kind"]);
await context.sync();
if (field.isNullObject) {
console.log("This document has no fields.");
} else {
console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
}
});
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é
parentBody
Obtient le corps parent du champ.
readonly parentBody: Word.Body;Valeur de propriété
Remarques
[ Ensemble d’API : WordApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml
// Gets the parent body of the first field in the document.
await Word.run(async (context) => {
const field = context.document.body.fields.getFirstOrNullObject();
field.load("parentBody/text");
await context.sync();
if (field.isNullObject) {
console.log("This document has no fields.");
} else {
const parentBody = field.parentBody;
console.log("Text of first field's parent body: " + JSON.stringify(parentBody.text));
}
});
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.
readonly parentContentControl: Word.ContentControl;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.
readonly parentContentControlOrNullObject: Word.ContentControl;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.
readonly parentTable: Word.Table;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.
readonly parentTableCell: Word.TableCell;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.
readonly parentTableCellOrNullObject: Word.TableCell;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.
readonly parentTableOrNullObject: Word.Table;Valeur de propriété
Remarques
result
Obtient les données de résultat du champ.
readonly result: Word.Range;Valeur de propriété
Remarques
[ Ensemble d’API : WordApi 1.4 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml
// Gets the first field in the document.
await Word.run(async (context) => {
const field = context.document.body.fields.getFirstOrNullObject();
field.load(["code", "result", "locked", "type", "data", "kind"]);
await context.sync();
if (field.isNullObject) {
console.log("This document has no fields.");
} else {
console.log("Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
}
});
Détails de la méthode
getNext()
Obtient le champ suivant. Génère une ItemNotFound erreur si ce champ est le dernier.
getNext(): Word.Field;Retours
Remarques
getNextOrNullObject()
Obtient le champ suivant. Si ce champ est le dernier, 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.
getNextOrNullObject(): Word.Field;Retours
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.FieldLoadOptions): Word.Field;Paramètres
- options
- Word.Interfaces.FieldLoadOptions
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.Field;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.Field;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.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Word.Interfaces.FieldUpdateData
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.Field): void;Paramètres
- properties
- Word.Field
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet Field est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.FieldDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Word.Interfaces.FieldData;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.Field;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.Field;Retours
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour