Field

Field class

Representerar ett Microsoft Word-dokumentfält.

För att lära dig mer, besökArbeta med Fields dokumentationsartikel.

public class Field

Egenskaper

namnBeskrivning
DisplayResult { get; }Hämtar texten som representerar det visade fältresultatet.
End { get; }Hämtar noden som representerar fältänden.
Format { get; }Får enFieldFormat objekt som ger maskinskriven åtkomst till fältets formatering.
IsDirty { get; set; }Hämtar eller ställer in om det aktuella resultatet av fältet inte längre är korrekt (inaktuellt) på grund av andra ändringar som gjorts i dokumentet.
IsLocked { get; set; }Hämtar eller ställer in om fältet är låst (ska inte räkna om resultatet).
LocaleId { get; set; }Hämtar eller ställer in LCID för fältet.
Result { get; set; }Hämtar eller ställer in text som är mellan fältavgränsaren och fältslutet.
Separator { get; }Hämtar noden som representerar fältseparatorn. Kan varanull .
Start { get; }Hämtar noden som representerar början av fältet.
virtual Type { get; }Hämtar fälttypen Microsoft Word.

Metoder

namnBeskrivning
GetFieldCode()Returnerar text mellan fältstart och fältavgränsare (eller fältslut om det inte finns någon avgränsare). Både fältkod och fältresultat för underordnade fält ingår.
GetFieldCode(bool)Returnerar text mellan fältstart och fältavgränsare (eller fältslut om det inte finns någon avgränsare).
Remove()Tar bort fältet från dokumentet. Returnerar en nod direkt efter fältet. Om fältets slut är den sista child av dess överordnade nod, returnerar dess överordnade stycke. Om fältet redan är borttaget, returnerasnull .
Unlink()Utför fältavlänkningen.
Update()Utför fältuppdateringen. Kastar om fältet redan uppdateras.
Update(bool)Utför en fältuppdatering. Kastar om fältet redan uppdateras.

Anmärkningar

Ett fält i ett Word-dokument är en komplex struktur som består av flera noder som inkluderar fältstart, fältkod, fältseparator, fältresultat och fältslut. Fält kan kapslas, innehålla rikt innehåll och span flera stycken eller avsnitt i ett dokument. DeField class är ett “fasad”-objekt som ger egenskaper och metoder som gör det möjligt att arbeta med ett fält som ett enda objekt.

DeStart ,Separator ochEnd egenskaper pekar på fältets start-, separator- och slutnod för fältet.

Innehållet mellan fältstart och separator är fältkoden. Innehållet mellan fältavgränsaren och fältslutet är fältresultatet. Fältkoden består vanligtvis av en eller flera Run objekt som anger instruktioner. Bearbetningsapplikationen förväntas exekvera fältkoden för att beräkna fältresultatet.

Processen att beräkna fältresultat kallas fältuppdatering. Aspose.Words kan uppdatera field resultat för de flesta fälttyper på exakt samma sätt som Microsoft Word gör det. Framför allt kan Aspose.Words beräkna resultaten av även de mest komplexa formelfälten. För att beräkna field -resultatet för ett enskilt fält användUpdate metod. För att uppdatera fält i hela document användUpdateFields.

Du kan få en vanlig textversion av fältkoden med hjälp avGetFieldCode method. Du kan hämta och ställa in oformaterad textversion av fältresultatet med hjälp avResult property. Både fältkoden och fältresultatet kan innehålla komplext innehåll, såsom kapslade fält, stycken, former, tabeller och i det här fallet kanske du vill arbeta med fältnoderna direkt om du behöver mer kontroll.

Du skapar inte instanser avField class direct. För att skapa ett nytt fält användInsertField metod.

Exempel

Visar hur man infogar ett fält i ett dokument med hjälp av en fältkod.

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

// Denna överbelastning av InsertField-metoden uppdaterar automatiskt infogade fält.
Assert.That(DateTime.Parse(field.Result), Is.EqualTo(DateTime.Today).Within(1).Days);

Se även

DropDownItemCollection Class FieldAddIn Class