FormField
Inhalt
[
Ausblenden
]FormField class
Stellt ein einzelnes Formularfeld dar.
Um mehr zu erfahren, besuchen Sie dieArbeiten mit Formularfeldern Dokumentationsartikel.
public class FormField : SpecialChar
Eigenschaften
| Name | Beschreibung |
|---|---|
| CalculateOnExit { get; set; } | Wahr, wenn Verweise auf das angegebene Formularfeld automatisch aktualisiert werden, wenn das Feld verlassen wird. |
| CheckBoxSize { get; set; } | Ermittelt oder setzt die Größe des Kontrollkästchens in Punkten. Wirkt sich nur aus, wennIsCheckBoxExactSize IstWAHR . |
| Checked { get; set; } | Ruft den aktivierten Status des Kontrollkästchen-Formularfelds ab oder legt ihn fest. Der Standardwert für diese Eigenschaft istFALSCH . |
| CustomNodeId { get; set; } | Gibt die benutzerdefinierte Knotenkennung an. |
| Default { get; set; } | Ruft den Standardwert des Kontrollkästchen-Formularfelds ab oder legt ihn fest. Der Standardwert für diese Eigenschaft istFALSCH . |
| virtual Document { get; } | Ruft das Dokument ab, zu dem dieser Knoten gehört. |
| DropDownItems { get; } | Bietet Zugriff auf die Elemente eines Dropdown-Formularfelds. |
| DropDownSelectedIndex { get; set; } | Ruft den Index ab oder legt ihn fest, der das aktuell ausgewählte Element in einem Dropdown-Formularfeld angibt. |
| Enabled { get; set; } | Wahr, wenn ein Formularfeld aktiviert ist. |
| EntryMacro { get; set; } | Gibt einen Eingabemakronamen für das Formularfeld zurück oder legt ihn fest. |
| ExitMacro { get; set; } | Gibt einen Exit-Makronamen für das Formularfeld zurück oder legt ihn fest. |
| Font { get; } | Bietet Zugriff auf die Schriftformatierung dieses Objekts. |
| HelpText { get; set; } | Gibt den Text zurück oder legt ihn fest, der in einem Meldungsfeld angezeigt wird, wenn das Formularfeld den Fokus hat und der Benutzer F1 drückt. |
| IsCheckBoxExactSize { get; set; } | Ruft den booleschen Wert ab oder legt ihn fest, der angibt, ob die Größe des Textfelds automatisch oder explizit angegeben wird. |
| virtual IsComposite { get; } | RückgabenWAHR wenn dieser Knoten andere Knoten enthalten kann. |
| IsDeleteRevision { get; } | Gibt „true“ zurück, wenn dieses Objekt in Microsoft Word gelöscht wurde, während die Änderungsverfolgung aktiviert war. |
| IsFormatRevision { get; } | Gibt „true“ zurück, wenn die Formatierung des Objekts in Microsoft Word geändert wurde, während die Änderungsverfolgung aktiviert war. |
| IsInsertRevision { get; } | Gibt „true“ zurück, wenn dieses Objekt in Microsoft Word eingefügt wurde, während die Änderungsverfolgung aktiviert war. |
| IsMoveFromRevision { get; } | RückgabenWAHR wenn dieses Objekt in Microsoft Word verschoben (gelöscht) wurde, während die Änderungsverfolgung aktiviert war. |
| IsMoveToRevision { get; } | RückgabenWAHR wenn dieses Objekt in Microsoft Word verschoben (eingefügt) wurde, während die Änderungsverfolgung aktiviert war. |
| MaxLength { get; set; } | Maximale Länge für das Textfeld. Null, wenn die Länge nicht begrenzt ist. |
| Name { get; set; } | Ruft den Formularfeldnamen ab oder legt ihn fest. |
| NextSibling { get; } | Ruft den Knoten ab, der diesem Knoten unmittelbar folgt. |
| override NodeType { get; } | RückgabenFormField . |
| OwnHelp { get; set; } | Gibt die Quelle des Textes an, der in einem Meldungsfeld angezeigt wird, wenn ein Formularfeld den Fokus hat und der Benutzer F1 drückt. |
| OwnStatus { get; set; } | Gibt die Quelle des Textes an, der in der Statusleiste angezeigt wird, wenn ein Formularfeld den Fokus hat. |
| ParentNode { get; } | Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab. |
| ParentParagraph { get; } | Ruft das übergeordnete Element abParagraph dieses Knotens. |
| PreviousSibling { get; } | Ruft den Knoten ab, der diesem Knoten unmittelbar vorausgeht. |
| Range { get; } | Gibt einenRangeObjekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist. |
| Result { get; set; } | Ruft eine Zeichenfolge ab oder legt sie fest, die das Ergebnis dieses Formularfelds darstellt. |
| StatusText { get; set; } | Gibt den Text zurück oder legt ihn fest, der in der Statusleiste angezeigt wird, wenn ein Formularfeld den Fokus hat. |
| TextInputDefault { get; set; } | Ruft die Standardzeichenfolge oder einen Berechnungsausdruck eines Textformularfelds ab oder legt diese fest. |
| TextInputFormat { get; set; } | Gibt die Textformatierung für ein Textformularfeld zurück oder legt sie fest. |
| TextInputType { get; set; } | Ruft den Typ eines Textformularfelds ab oder legt ihn fest. |
| Type { get; } | Gibt den Formularfeldtyp zurück. |
Methoden
| Name | Beschreibung |
|---|---|
| override Accept(DocumentVisitor) | Nimmt einen Besucher auf. |
| Clone(bool) | Erstellt ein Duplikat des Knotens. |
| GetAncestor(NodeType) | Ruft den ersten Vorfahren des angegebenenNodeType . |
| GetAncestor(Type) | Ruft den ersten Vorgänger des angegebenen Objekttyps ab. |
| override GetText() | Ruft das Sonderzeichen ab, das dieser Knoten darstellt. |
| NextPreOrder(Node) | Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab. |
| PreviousPreOrder(Node) | Ruft den vorherigen Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab. |
| Remove() | Entfernt sich selbst vom übergeordneten Element. |
| RemoveField() | Entfernt das komplette Formularfeld, nicht nur die Sonderzeichen im Formularfeld. |
| SetTextInputValue(object) | Wendet das inTextInputFormat und speichert den Wert inResult . |
| ToString(SaveFormat) | Exportiert den Inhalt des Knotens in eine Zeichenfolge im angegebenen Format. |
| ToString(SaveOptions) | Exportiert den Inhalt des Knotens unter Verwendung der angegebenen Speicheroptionen in eine Zeichenfolge. |
Bemerkungen
Microsoft Word bietet folgende Formularfelder: Kontrollkästchen, Texteingabe und Dropdown (Kombinationsfeld).
FormField ist ein Inline-Knoten und kann nur ein Kind vonParagraph.
FormField wird in einem Dokument durch ein Sonderzeichen und dargestellt, das als Zeichen innerhalb einer Textzeile positioniert ist.
Ein vollständiges Formularfeld in einem Word-Dokument ist eine komplexe Struktur, die durch mehrere Knoten dargestellt wird: Feldanfang, Feldcode (z. B. FORMTEXT), Formularfelddaten, Feldtrennzeichen, Feldergebnis, Feldende und ein Lesezeichen. Um Formularfelder in einem Word-Dokument programmgesteuert zu erstellen, verwenden SieInsertCheckBox , InsertTextInput und InsertComboBoxwhich stellt sicher, dass alle Formularfeldknoten in der richtigen Reihenfolge und in einem geeigneten Zustand erstellt werden.
Beispiele
Zeigt, wie das gesamte Formularfeld einschließlich des Feldwerts formatiert wird.
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());
Zeigt, wie ein Kombinationsfeld eingefügt wird.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Please select a fruit: ");
// Fügen Sie ein Kombinationsfeld ein, das es einem Benutzer ermöglicht, eine Option aus einer Sammlung von Zeichenfolgen auszuwählen.
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);
// Das Formularfeld wird in Form eines „Select“-HTML-Tags angezeigt.
doc.Save(ArtifactsDir + "FormFields.Create.html");
Siehe auch
- class SpecialChar
- namensraum Aspose.Words.Fields
- Montage Aspose.Words
