FormField

FormField class

Rappresenta un singolo campo del modulo.

Per saperne di più, visita ilLavorare con i campi del modulo articolo di documentazione.

public class FormField : SpecialChar

Proprietà

NomeDescrizione
CalculateOnExit { get; set; }Vero se i riferimenti al campo del modulo specificato vengono aggiornati automaticamente ogni volta che si esce dal campo.
CheckBoxSize { get; set; }Ottiene o imposta la dimensione della casella di controllo in punti. Ha effetto solo quandoIsCheckBoxExactSize ÈVERO .
Checked { get; set; }Ottiene o imposta lo stato di selezione del campo del modulo della casella di controllo. Il valore predefinito per questa proprietà èfalso .
CustomNodeId { get; set; }Specifica l’identificatore del nodo personalizzato.
Default { get; set; }Ottiene o imposta il valore predefinito del campo del modulo della casella di controllo. Il valore predefinito per questa proprietà èfalso .
virtual Document { get; }Ottiene il documento a cui appartiene questo nodo.
DropDownItems { get; }Fornisce l’accesso agli elementi di un campo del modulo a discesa.
DropDownSelectedIndex { get; set; }Ottiene o imposta l’indice che specifica l’elemento attualmente selezionato in un campo del modulo a discesa.
Enabled { get; set; }Vero se un campo del modulo è abilitato.
EntryMacro { get; set; }Restituisce o imposta un nome macro di immissione per il campo del modulo.
ExitMacro { get; set; }Restituisce o imposta un nome macro di uscita per il campo del modulo.
Font { get; }Fornisce l’accesso alla formattazione del carattere di questo oggetto.
HelpText { get; set; }Restituisce o imposta il testo visualizzato in una finestra di messaggio quando il campo del modulo è attivo e l’utente preme F1.
IsCheckBoxExactSize { get; set; }Ottiene o imposta il valore booleano che indica se la dimensione della casella di testo è automatica o specificata esplicitamente.
virtual IsComposite { get; }RestituisceVERO se questo nodo può contenere altri nodi.
IsDeleteRevision { get; }Restituisce true se questo oggetto è stato eliminato in Microsoft Word mentre il monitoraggio delle modifiche era abilitato.
IsFormatRevision { get; }Restituisce true se la formattazione dell’oggetto è stata modificata in Microsoft Word mentre il rilevamento delle modifiche era abilitato.
IsInsertRevision { get; }Restituisce true se questo oggetto è stato inserito in Microsoft Word mentre il rilevamento delle modifiche era abilitato.
IsMoveFromRevision { get; }RestituisceVERO se questo oggetto è stato spostato (eliminato) in Microsoft Word mentre il monitoraggio delle modifiche era abilitato.
IsMoveToRevision { get; }RestituisceVERO se questo oggetto è stato spostato (inserito) in Microsoft Word mentre il monitoraggio delle modifiche era abilitato.
MaxLength { get; set; }Lunghezza massima per il campo di testo. Zero se la lunghezza non è limitata.
Name { get; set; }Ottiene o imposta il nome del campo del modulo.
NextSibling { get; }Ottiene il nodo immediatamente successivo a questo nodo.
override NodeType { get; }RestituisceFormField .
OwnHelp { get; set; }Specifica l’origine del testo visualizzato in una finestra di messaggio quando un campo del modulo ha il focus e l’utente preme F1.
OwnStatus { get; set; }Specifica l’origine del testo visualizzato nella barra di stato quando un campo del modulo è attivo.
ParentNode { get; }Ottiene il genitore immediato di questo nodo.
ParentParagraph { get; }Recupera il genitoreParagraph di questo nodo.
PreviousSibling { get; }Ottiene il nodo immediatamente precedente questo nodo.
Range { get; }Restituisce unRangeoggetto che rappresenta la porzione di un documento contenuta in questo nodo.
Result { get; set; }Ottiene o imposta una stringa che rappresenta il risultato di questo campo del modulo.
StatusText { get; set; }Restituisce o imposta il testo visualizzato nella barra di stato quando un campo del modulo è attivo.
TextInputDefault { get; set; }Ottiene o imposta la stringa predefinita o un’espressione di calcolo di un campo di modulo di testo.
TextInputFormat { get; set; }Restituisce o imposta la formattazione del testo per un campo modulo di testo.
TextInputType { get; set; }Ottiene o imposta il tipo di un campo di modulo di testo.
Type { get; }Restituisce il tipo di campo del modulo.

Metodi

NomeDescrizione
override Accept(DocumentVisitor)Accetta un visitatore.
Clone(bool)Crea un duplicato del nodo.
GetAncestor(NodeType)Ottiene il primo antenato dell’oggetto specificatoNodeType .
GetAncestor(Type)Ottiene il primo antenato del tipo di oggetto specificato.
override GetText()Ottiene il carattere speciale rappresentato da questo nodo.
NextPreOrder(Node)Ottiene il nodo successivo in base all’algoritmo di attraversamento dell’albero preordinato.
PreviousPreOrder(Node)Ottiene il nodo precedente secondo l’algoritmo di attraversamento dell’albero preordinato.
Remove()Si rimuove dal genitore.
RemoveField()Rimuove il campo modulo completo, non solo il carattere speciale del campo modulo.
SetTextInputValue(object)Applica il formato di testo specificato inTextInputFormat e memorizza il valore inResult .
ToString(SaveFormat)Esporta il contenuto del nodo in una stringa nel formato specificato.
ToString(SaveOptions)Esporta il contenuto del nodo in una stringa utilizzando le opzioni di salvataggio specificate.

Osservazioni

Microsoft Word fornisce i seguenti campi modulo: casella di controllo, immissione di testo e menu a discesa (casella combinata).

FormField è un nodo inline e può essere solo un figlio diParagraph.

FormField è rappresentato in un documento da un carattere speciale and posizionato come carattere all’interno di una riga di testo.

Un campo modulo completo in un documento Word è una struttura complessa rappresentata da diversi nodi : inizio campo, codice campo come FORMTEXT, dati campo modulo, separatore campo, risultato campo , fine campo e un segnalibro. Per creare campi modulo in un documento Word a livello di codice, utilizzare InsertCheckBox , InsertTextInput e InsertComboBoxwhich assicura che tutti i nodi dei campi del modulo siano creati nell’ordine corretto e in uno stato adatto.

Esempi

Mostra come formattare l’intero FormField, incluso il valore del campo.

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());

Mostra come inserire una casella combinata.

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

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

// Inserisce una casella combinata che consentirà all'utente di scegliere un'opzione da una raccolta di stringhe.
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);

// Il campo del modulo apparirà sotto forma di tag HTML "select".
doc.Save(ArtifactsDir + "FormFields.Create.html");

Guarda anche