Field

Field class

Representerar ett fält i ett Microsoft Word-dokument.

För att lära dig mer, besökArbeta med fält 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ältets slut.
Format { get; }Får enFieldFormatobjekt som ger typad åtkomst till fältets formatering.
IsDirty { get; set; }Hämtar eller anger 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 anger om fältet är låst (resultatet ska inte beräknas om).
LocaleId { get; set; }Hämtar eller ställer in fältets LCID.
Result { get; set; }Hämtar eller anger 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 underfält inkluderas.
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 undernoden till dess överordnade nod, returneras dess överordnade stycke. Om fältet redan är borttaget returnerasnull .
Unlink()Utför fältavkopplingen.
Update()Utför fältuppdateringen. Körs om fältet redan uppdateras.
Update(bool)Utför en fältuppdatering. Körs 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ältavgränsare, fältresultat och fältslut. Fält kan kapslas, innehålla rikt innehåll och spänna över flera stycken eller avsnitt i ett dokument.Field klassen är ett “fasad”-objekt som tillhandahåller egenskaper och metoder som gör det möjligt att arbeta med ett fält som ett enda objekt.

DeStart ,Separator ochEnd Egenskaperna pekar på fältets start-, separator- respektive slutnoder för fältet .

Innehållet mellan fältets början och avgränsare är fältkoden. Innehållet mellan fältavgränsaren och fältets slut ä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 resultat även för 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 dokumentet användUpdateFields.

Du kan få den oformaterade textversionen av fältkoden med hjälp avGetFieldCodemetod. Du kan hämta och ställa in den oformaterade textversionen 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 direkt med fältnoderna om du behöver mer kontroll.

Du skapar inte instanser avField klass direkt. 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.True((DateTime.Today - DateTime.Parse(field.Result)).Days <= 1);

Se även

DropDownItemCollection Class FieldAddIn Class