Field

Field class

Stellt ein Microsoft Word-Dokumentfeld dar.

Um mehr zu erfahren, besuchen Sie dieArbeiten mit Feldern Dokumentationsartikel.

public class Field

Eigenschaften

NameBeschreibung
DisplayResult { get; }Ruft den Text ab, der das angezeigte Feldergebnis darstellt.
End { get; }Ruft den Knoten ab, der das Feldende darstellt.
Format { get; }Erhält eineFieldFormatObjekt, das typisierten Zugriff auf die Formatierung des Felds bietet.
IsDirty { get; set; }Ruft ab oder legt fest, ob das aktuelle Ergebnis des Felds aufgrund anderer am Dokument vorgenommener Änderungen nicht mehr korrekt (veraltet) ist.
IsLocked { get; set; }Ruft ab oder legt fest, ob das Feld gesperrt ist (das Ergebnis sollte nicht neu berechnet werden).
LocaleId { get; set; }Ruft die LCID des Felds ab oder legt sie fest.
Result { get; set; }Ruft Text ab oder legt ihn fest, der zwischen Feldtrennzeichen und Feldende steht.
Separator { get; }Ruft den Knoten ab, der das Feldtrennzeichen darstellt. Kann seinnull .
Start { get; }Ruft den Knoten ab, der den Anfang des Felds darstellt.
virtual Type { get; }Ruft den Microsoft Word-Feldtyp ab.

Methoden

NameBeschreibung
GetFieldCode()Gibt Text zwischen Feldanfang und Feldtrennzeichen zurück (oder Feldende, wenn kein Trennzeichen vorhanden ist). Sowohl Feldcode als auch Feldergebnis von untergeordneten Feldern werden einbezogen.
GetFieldCode(bool)Gibt Text zwischen Feldanfang und Feldtrennzeichen zurück (oder Feldende, wenn kein Trennzeichen vorhanden ist).
Remove()Entfernt das Feld aus dem Dokument. Gibt einen Knoten direkt nach dem Feld zurück. Wenn das Ende des Felds das letzte Kind seines übergeordneten Knotens ist, wird dessen übergeordneter Absatz zurückgegeben. Wenn das Feld bereits entfernt wurde, wird zurückgegebennull .
Unlink()Führt die Feldverknüpfung aus.
Update()Führt die Feldaktualisierung durch. Wird ausgelöst, wenn das Feld bereits aktualisiert wird.
Update(bool)Führt eine Feldaktualisierung durch. Wird ausgelöst, wenn das Feld bereits aktualisiert wird.

Bemerkungen

Ein Feld in einem Word-Dokument ist eine komplexe Struktur, die aus mehreren Knoten besteht, darunter Feldstart, Feldcode, Feldtrennzeichen, Feldergebnis und Feldende. Felder können verschachtelt sein, umfangreichen Inhalt enthalten und mehrere Absätze oder Abschnitte in einem Dokument umfassen. DieField Die Klasse ist ein „Fassaden“-Objekt, das x000d-Eigenschaften und -Methoden bereitstellt, die es ermöglichen, mit einem Feld als einzelnem Objekt zu arbeiten.

DerStart ,Separator UndEnd Eigenschaften verweisen jeweils auf den -Feldstart-, Trenn- und Endknoten des Felds.

Der Inhalt zwischen Feldanfang und Feldtrennzeichen ist der Feldcode. Der Inhalt zwischen dem Feldtrennzeichen und dem Feldende ist das Feldergebnis. Der Feldcode besteht typischerweise aus einem oder mehreren Run Objekte, die Anweisungen angeben. Von der verarbeitenden Anwendung wird erwartet, dass sie den Feldcode ausführt, um das Feldergebnis zu berechnen.

Die Berechnung der Feldergebnisse wird als Feldaktualisierung bezeichnet. Aspose.Words kann die Ergebnisse der meisten Feldtypen genau wie Microsoft Word aktualisieren. Insbesondere berechnet Aspose.Words die Ergebnisse selbst der komplexesten Formelfelder. Um das Ergebnis eines einzelnen Feldes zu berechnen, verwenden Sie dieUpdate Methode. Um Felder im gesamten Dokument zu aktualisieren, verwenden SieUpdateFields.

Sie können die Klartextversion des Feldcodes erhalten, indem SieGetFieldCodemethod. Sie können die reine Textversion des Feldergebnisses abrufen und festlegen mit derResult property. Sowohl der Feldcode als auch das Feldergebnis können komplexe Inhalte enthalten, wie etwa verschachtelte Felder, Absätze, Formen, Tabellen. In diesem Fall möchten Sie möglicherweise direkt mit den Feldknoten arbeiten, wenn Sie mehr Kontrolle benötigen.

Sie erstellen keine Instanzen desField Klasse direkt. Um ein neues Feld zu erstellen, verwenden Sie dieInsertField Verfahren.

Beispiele

Zeigt, wie Sie mithilfe eines Feldcodes ein Feld in ein Dokument einfügen.

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

Field field = builder.InsertField("DATE \\@ \"dddd, MMMM dd, yyyy\"");

Assert.AreEqual(FieldType.FieldDate, field.Type);
Assert.AreEqual("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.GetFieldCode());

// Diese Überladung der InsertField-Methode aktualisiert eingefügte Felder automatisch.
Assert.True((DateTime.Today - DateTime.Parse(field.Result)).Days <= 1);

Siehe auch