FormField

FormField class

Représente un seul champ de formulaire.

Pour en savoir plus, visitez leTravailler avec les champs de formulaire article de documentation.

public class FormField : SpecialChar

Propriétés

NomLa description
CalculateOnExit { get; set; }Vrai si les références au champ de formulaire spécifié sont automatiquement mises à jour chaque fois que le champ est quitté.
CheckBoxSize { get; set; }Obtient ou définit la taille de la case à cocher en points. Effet uniquement lorsqueIsCheckBoxExactSize estvrai .
Checked { get; set; }Obtient ou définit l’état coché du champ de formulaire de case à cocher. La valeur par défaut de cette propriété estFAUX .
CustomNodeId { get; set; }Spécifie l’identifiant de nœud personnalisé.
Default { get; set; }Obtient ou définit la valeur par défaut du champ de formulaire de case à cocher. La valeur par défaut de cette propriété estFAUX .
virtual Document { get; }Obtient le document auquel appartient ce nœud.
DropDownItems { get; }Donne accès aux éléments d’un champ de formulaire déroulant.
DropDownSelectedIndex { get; set; }Obtient ou définit l’index spécifiant l’élément actuellement sélectionné dans un champ de formulaire déroulant.
Enabled { get; set; }Vrai si un champ de formulaire est activé.
EntryMacro { get; set; }Renvoie ou définit un nom de macro d’entrée pour le champ de formulaire.
ExitMacro { get; set; }Renvoie ou définit un nom de macro de sortie pour le champ de formulaire.
Font { get; }Donne accès à la mise en forme de la police de cet objet.
HelpText { get; set; }Renvoie ou définit le texte qui s’affiche dans une boîte de message lorsque le champ de formulaire a le focus et que l’utilisateur appuie sur F1.
IsCheckBoxExactSize { get; set; }Obtient ou définit la valeur booléenne qui indique si la taille de la zone de texte est automatique ou spécifiée explicitement.
virtual IsComposite { get; }Retoursvrai si ce nœud peut contenir d’autres nœuds.
IsDeleteRevision { get; }Renvoie vrai si cet objet a été supprimé dans Microsoft Word alors que le suivi des modifications était activé.
IsFormatRevision { get; }Renvoie true si la mise en forme de l’objet a été modifiée dans Microsoft Word alors que le suivi des modifications était activé.
IsInsertRevision { get; }Renvoie vrai si cet objet a été inséré dans Microsoft Word alors que le suivi des modifications était activé.
IsMoveFromRevision { get; }Retoursvrai si cet objet a été déplacé (supprimé) dans Microsoft Word alors que le suivi des modifications était activé.
IsMoveToRevision { get; }Retoursvrai si cet objet a été déplacé (inséré) dans Microsoft Word alors que le suivi des modifications était activé.
MaxLength { get; set; }Longueur maximale du champ de texte. Zéro si la longueur n’est pas limitée.
Name { get; set; }Obtient ou définit le nom du champ de formulaire.
NextSibling { get; }Obtient le nœud suivant immédiatement ce nœud.
override NodeType { get; }RetoursFormField .
OwnHelp { get; set; }Spécifie la source du texte qui s’affiche dans une boîte de message lorsqu’un champ de formulaire est activé et que l’utilisateur appuie sur F1.
OwnStatus { get; set; }Spécifie la source du texte affiché dans la barre d’état lorsqu’un champ de formulaire a le focus.
ParentNode { get; }Obtient le parent immédiat de ce nœud.
ParentParagraph { get; }Récupère le parentParagraph de ce nœud.
PreviousSibling { get; }Obtient le nœud précédant immédiatement ce nœud.
Range { get; }Renvoie unRangeobjet qui représente la partie d’un document contenue dans ce nœud.
Result { get; set; }Obtient ou définit une chaîne qui représente le résultat de ce champ de formulaire.
StatusText { get; set; }Renvoie ou définit le texte qui s’affiche dans la barre d’état lorsqu’un champ de formulaire a le focus.
TextInputDefault { get; set; }Obtient ou définit la chaîne par défaut ou une expression de calcul d’un champ de formulaire texte.
TextInputFormat { get; set; }Renvoie ou définit la mise en forme du texte pour un champ de formulaire texte.
TextInputType { get; set; }Obtient ou définit le type d’un champ de formulaire texte.
Type { get; }Renvoie le type de champ de formulaire.

Méthodes

NomLa description
override Accept(DocumentVisitor)Accepte un visiteur.
Clone(bool)Crée un doublon du nœud.
GetAncestor(NodeType)Obtient le premier ancêtre du spécifiéNodeType .
GetAncestor(Type)Obtient le premier ancêtre du type d’objet spécifié.
override GetText()Obtient le caractère spécial que ce nœud représente.
NextPreOrder(Node)Obtient le nœud suivant selon l’algorithme de parcours de l’arbre de pré-ordre.
PreviousPreOrder(Node)Obtient le nœud précédent selon l’algorithme de parcours de l’arbre de pré-ordre.
Remove()Se supprime du parent.
RemoveField()Supprime le champ de formulaire complet, pas seulement le caractère spécial du champ de formulaire.
SetTextInputValue(object)Applique le format de texte spécifié dansTextInputFormat et stocke la valeur dansResult .
ToString(SaveFormat)Exporte le contenu du nœud dans une chaîne au format spécifié.
ToString(SaveOptions)Exporte le contenu du nœud dans une chaîne en utilisant les options de sauvegarde spécifiées.

Remarques

Microsoft Word fournit les champs de formulaire suivants : case à cocher, saisie de texte et liste déroulante (zone de liste déroulante).

FormField est un nœud en ligne et ne peut être qu’un enfant deParagraph.

FormField est représenté dans un document par un caractère spécial and positionné comme un caractère dans une ligne de texte.

Un champ de formulaire complet dans un document Word est une structure complexe représentée par plusieurs nœuds : début du champ, code du champ (par exemple, FORMTEXT), données du champ, séparateur du champ, résultat du champ, fin du champ et signet. Pour créer des champs de formulaire par programmation dans un document Word, utilisez .InsertCheckBox , InsertTextInput et InsertComboBoxwhich s’assure que tous les nœuds de champ de formulaire sont créés dans un ordre correct et dans un état approprié.

Exemples

Montre comment formater l’intégralité du champ de formulaire, y compris la valeur du champ.

Document doc = new Document(MyDir + "Form fields.docx");

FormField formField = doc.Range.FormFields[0];
formField.Font.Bold = true;
formField.Font.Size = 24;
formField.Font.Color = Color.Red;

formField.Result = "Aspose.FormField";

doc = DocumentHelper.SaveOpen(doc);

Run formFieldRun = doc.FirstSection.Body.FirstParagraph.Runs[1];

Assert.AreEqual("Aspose.FormField", formFieldRun.Text);
Assert.AreEqual(true, formFieldRun.Font.Bold);
Assert.AreEqual(24, formFieldRun.Font.Size);
Assert.AreEqual(Color.Red.ToArgb(), formFieldRun.Font.Color.ToArgb());

Montre comment insérer une zone de liste déroulante.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("Please select a fruit: ");

// Insérer une zone de liste déroulante qui permettra à un utilisateur de choisir une option parmi une collection de chaînes.
FormField comboBox = builder.InsertComboBox("MyComboBox", new[] { "Apple", "Banana", "Cherry" }, 0);

Assert.AreEqual("MyComboBox", comboBox.Name);
Assert.AreEqual(FieldType.FieldFormDropDown, comboBox.Type);
Assert.AreEqual("Apple", comboBox.Result);

// Le champ de formulaire apparaîtra sous la forme d'une balise HTML « select ».
doc.Save(ArtifactsDir + "FormFields.Create.html");

Voir également

FieldXE Class FormFieldCollection Class