Insérer des champs

Il existe plusieurs manières d’insérer des champs dans un document:

Dans cet article, nous examinerons chaque méthode plus en détail et analyserons comment insérer certains champs à l’aide de ces options.

Insertion de champs dans un document à l’aide de DocumentBuilder

Dans Aspose.Words, la méthode insert_field est utilisée pour insérer de nouveaux champs dans un document. Le premier paramètre accepte le code de champ complet du champ à insérer. Le deuxième paramètre est facultatif et permet de définir manuellement le résultat du champ. Si celui-ci n’est pas renseigné, le champ est mis à jour automatiquement. Vous pouvez passer null ou vide à ce paramètre pour insérer un champ avec une valeur de champ vide. Si vous n’êtes pas sûr de la syntaxe particulière du code de champ, créez d’abord le champ en Microsoft Word et basculez pour voir son code de champ.

L’exemple de code suivant montre comment insérer un champ de fusion dans un document à l’aide de DocumentBuilder:

L’exemple de code suivant montre comment insérer un champ de fusion avec les paramètres régionaux allemands dans un document à l’aide de DocumentBuilder:

La même technique est utilisée pour insérer des champs imbriqués dans d’autres champs.

L’exemple de code suivant montre comment insérer des champs imbriqués dans un autre champ à l’aide de DocumentBuilder:

Spécifier les paramètres régionaux au niveau du champ

Un identifiant de langue est une abréviation numérique internationale standard pour la langue d’un pays ou d’une région géographique. Avec Aspose.Words, vous pouvez spécifier les paramètres régionaux au niveau du champ. La propriété locale_id obtient ou définit l’ID de paramètres régionaux du champ.

L’exemple de code suivant montre comment utiliser cette option:

Insérer un champ non typé/vide

Si vous souhaitez insérer des champs non typés/vides ({}) comme le permet Microsoft Word, vous pouvez utiliser la méthode insert_field avec le paramètre FieldType.FIELD_NONE. Pour insérer un champ dans un document Word, vous pouvez appuyer sur la combinaison de touches “Ctrl + F9”.

L’exemple de code suivant montre comment insérer un champ vide dans le document:

Insertion de champs dans un document à l’aide de FieldBuilder

L’autre façon d’insérer des champs dans Aspose.Words est la classe FieldBuilder. Il fournit une interface fluide pour spécifier les commutateurs de champs et les valeurs d’arguments sous forme de texte, de nœuds ou même de champs imbriqués.

L’exemple de code suivant montre comment insérer un champ dans un document à l’aide de FieldBuilder:

Insertion de champs à l’aide de DOM

Vous pouvez également insérer différents types de champs à l’aide de Aspose.Words Document Object Model (DOM). Dans cette section, nous examinerons quelques exemples.

Insertion d’un champ de fusion dans un document à l’aide de DOM

Le champ MERGEFIELD dans un document Word peut être représenté par la classe FieldMergeField. Vous pouvez utiliser la classe FieldMergeField pour effectuer les opérations suivantes:

  • préciser le nom du champ de fusion
  • spécifier le formatage du champ de fusion
  • spécifiez le texte qui se trouve entre le séparateur de champ et la fin du champ de fusion
  • préciser le texte à insérer après le champ de fusion si le champ n’est pas vide
  • préciser le texte à insérer avant le champ de fusion si le champ n’est pas vide

L’exemple de code suivant montre comment ajouter un champ Merge à l’aide de DOM à un paragraphe d’un document:

Insertion du champ Mail Merge ADDRESSBLOCK dans un document à l’aide de DOM

Le champ ADDRESSBLOCK est utilisé pour insérer un bloc d’adresse Mail Merge dans un document Word. Le champ ADDRESSBLOCK dans un document Word peut être représenté par la classe FieldAddressBlock. Vous pouvez utiliser la classe FieldAddressBlock pour effectuer les opérations suivantes:

  • préciser s’il faut inclure le nom du pays/de la région dans le champ
  • préciser s’il faut formater l’adresse en fonction du pays/région du destinataire tel que défini par POST*CODE (Union postale universelle 2006)
  • précisez le nom du pays/de la région exclu
  • préciser le format du nom et de l’adresse
  • spécifier l’ID de langue utilisé pour formater l’adresse

L’exemple de code suivant montre comment ajouter le champ ADDRESSBLOCK Mail Merge à l’aide de DOM à un paragraphe d’un document:

Insertion d’un champ ADVANCE dans un document sans utiliser DocumentBuilder

Le champ ADVANCE est utilisé pour décaler le texte suivant dans une ligne vers la gauche, la droite, le haut ou le bas. Le champ ADVANCE dans un document Word peut être représenté par la classe FieldAdvance. Vous pouvez utiliser la classe FieldAdvance pour effectuer les opérations suivantes:

  • préciser le nombre de points dont le texte qui suit le champ doit être déplacé verticalement à partir du bord supérieur de la page
  • spécifiez le nombre de points dont le texte qui suit le champ doit être déplacé horizontalement à partir du bord gauche de la colonne, du cadre ou de la zone de texte
  • préciser le nombre de points dont le texte qui suit le champ doit être déplacé vers la gauche, la droite, le haut ou le bas

L’exemple de code suivant montre comment ajouter le champ ADVANCE à l’aide de DOM à un paragraphe d’un document.

Insertion d’un champ ASK dans un document sans utiliser DocumentBuilder

Le champ ASK est utilisé pour demander à l’utilisateur le texte à attribuer à un signet dans un document Word. Le champ ASK dans un document Word peut être représenté par la classe FieldAsk. Vous pouvez utiliser la classe FieldAsk pour effectuer les opérations suivantes:

  • préciser le nom du signet
  • spécifier la réponse utilisateur par défaut (valeur initiale contenue dans la fenêtre d’invite)
  • spécifier si la réponse de l’utilisateur doit être reçue une fois par opération mail merge
  • spécifiez le texte de l’invite (le titre de la fenêtre d’invite)

L’exemple de code suivant montre comment ajouter le champ ASK à l’aide de DOM à un paragraphe d’un document:

Insertion d’un champ AUTHOR dans un document sans utiliser DocumentBuilder

Le champ AUTHOR permet de préciser le nom de l’auteur du document à partir des propriétés Document. Le champ AUTHOR dans un document Word peut être représenté par la classe FieldAuthor. Vous pouvez utiliser la classe FieldAuthor pour effectuer les opérations suivantes:

  • préciser le nom de l’auteur du document

L’exemple de code suivant montre comment ajouter le champ AUTHOR à l’aide de DOM à un paragraphe d’un document:

Insertion d’un champ INCLUDETEXT dans un document sans utiliser DocumentBuilder

Le champ INCLUDETEXT insère le texte et les graphiques contenus dans le document nommé dans le code du champ. Vous pouvez insérer l’intégralité du document ou une partie du document référencé par un signet. Ce champ dans le document Word est représenté par INCLUDETEXT. Vous pouvez utiliser la classe FieldIncludeText pour effectuer les opérations suivantes:

  • précisez le nom du signet du document inclus
  • préciser l’emplacement du document

L’exemple de code suivant montre comment ajouter le champ INCLUDETEXT à l’aide de DOM à un paragraphe d’un document:

Insertion d’un champ TOA dans un document sans utiliser DocumentBuilder

Le champ TOA (Table of Authorities) construit et insère une table d’autorités. Le champ TOA collecte les entrées marquées par les champs TA (Table of Authorities Entry). Microsoft Office Word insère le champ TOA lorsque vous cliquez sur Insérer une table des autorités dans le groupe Tableau des autorités de l’onglet References. Lorsque vous affichez le champ TOA dans votre document, la syntaxe ressemble à ceci:

{ TOA [Switches ] }

Vous pouvez utiliser la classe FieldToa pour effectuer les opérations avec le champ TOA.

L’exemple de code suivant montre comment ajouter le champ TOA à l’aide de DOM à un paragraphe d’un document:

Présentation des champs dans Python Rechercher des propriétés de champ dans Python