FormField

FormField class

Representerar ett enda formulärfält.

public class FormField : SpecialChar

Egenskaper

namn Beskrivning
CalculateOnExit { get; set; } Sant om referenser till det angivna formulärfältet uppdateras automatiskt när fältet avslutas.
CheckBoxSize { get; set; } Hämtar eller ställer in storleken på kryssrutan i poäng. Har effekt endast närIsCheckBoxExactSize är sant.
Checked { get; set; } Hämtar eller ställer in den markerade statusen för kryssrutans formulärfält. Standardvärdet för den här egenskapen är falsk .
CustomNodeId { get; set; } Anger anpassad nodidentifierare.
Default { get; set; } Hämtar eller ställer in standardvärdet för kryssrutans formulärfält. Standardvärdet för den här egenskapen är falsk .
virtual Document { get; } Hämtar dokumentet som denna nod tillhör.
DropDownItems { get; } Ger tillgång till objekten i ett rullgardinsformulärfält.
DropDownSelectedIndex { get; set; } Hämtar eller ställer in indexet som anger det för närvarande valda objektet i ett rullgardinsfält.
Enabled { get; set; } True om ett formulärfält är aktiverat.
EntryMacro { get; set; } Returnerar eller ställer in ett postmakronamn för formulärfältet.
ExitMacro { get; set; } Returnerar eller ställer in ett utgångsmakronamn för formulärfältet.
Font { get; } Ger tillgång till teckensnittsformateringen för detta objekt.
HelpText { get; set; } Returnerar eller ställer in texten som visas i en meddelanderuta när formulärfältet har fokus och användaren trycker på F1.
IsCheckBoxExactSize { get; set; } Hämtar eller ställer in det booleska värdet som indikerar om storleken på textrutan är automatisk eller specificerad explicit.
virtual IsComposite { get; } Returnerar sant om denna nod kan innehålla andra noder.
IsDeleteRevision { get; } Returnerar sant om detta objekt raderades i Microsoft Word medan ändringsspårning var aktiverad.
IsFormatRevision { get; } Returnerar sant om formateringen av objektet ändrades i Microsoft Word medan ändringsspårning var aktiverad.
IsInsertRevision { get; } Returnerar sant om det här objektet infogades i Microsoft Word medan ändringsspårning var aktiverad.
IsMoveFromRevision { get; } Returnerar Sann om det här objektet flyttades (borttogs) i Microsoft Word medan ändringsspårning var aktiverad.
IsMoveToRevision { get; } Returnerar Sann om detta objekt flyttades (infogades) i Microsoft Word medan ändringsspårning var aktiverad.
MaxLength { get; set; } Maximal längd för textfältet. Noll när längden inte är begränsad.
Name { get; set; } Hämtar eller ställer in formulärfältets namn.
NextSibling { get; } Hämtar noden omedelbart efter denna nod.
override NodeType { get; } Returnerar NodeType.FormField .
OwnHelp { get; set; } Anger källan till texten som visas i en meddelanderuta när ett formulärfält har fokus och användaren trycker på F1.
OwnStatus { get; set; } Anger källan till texten som visas i statusfältet när ett formulärfält har fokus.
ParentNode { get; } Hämtar den omedelbara föräldern till denna nod.
ParentParagraph { get; } Hämtar föräldernParagraph av denna nod.
PreviousSibling { get; } Hämtar noden omedelbart före denna nod.
Range { get; } Returnerar en Räckvidd objekt som representerar den del av ett dokument som finns i denna nod.
Result { get; set; } Hämtar eller ställer in en sträng som representerar resultatet av detta formulärfält.
StatusText { get; set; } Returnerar eller ställer in texten som visas i statusfältet när ett formulärfält har fokus.
TextInputDefault { get; set; } Hämtar eller ställer in standardsträngen eller ett beräkningsuttryck för ett textformulärfält.
TextInputFormat { get; set; } Returnerar eller ställer in textformateringen för ett textformulärfält.
TextInputType { get; set; } Hämtar eller ställer in typen av ett textformulärfält.
Type { get; } Returnerar formulärfältstypen.

Metoder

namn Beskrivning
override Accept(DocumentVisitor) Accepterar en besökare.
Clone(bool) Skapar en dubblett av noden.
GetAncestor(NodeType) Hämtar den första förfadern till den angivnaNodeType .
GetAncestor(Type) Hämtar den första förfadern till den angivna objekttypen.
override GetText() Får specialtecknet som denna nod representerar.
NextPreOrder(Node) Hämtar nästa nod enligt algoritmen för förbeställningsträdet.
PreviousPreOrder(Node) Hämtar föregående nod enligt algoritmen för förbeställningsträdet.
Remove() Tar bort sig själv från föräldern.
RemoveField() Tar bort hela formulärfältet, inte bara formulärfältets specialtecken.
SetTextInputValue(object) Tillämpar textformatet som anges iTextInputFormat och lagrar värdet iResult .
ToString(SaveFormat) Exporterar innehållet i noden till en sträng i angivet format.
ToString(SaveOptions) Exporterar innehållet i noden till en sträng med de angivna sparalternativen.

Anmärkningar

Microsoft Word tillhandahåller följande formulärfält: kryssruta, textinmatning och rullgardinsmeny (kombobox).

FormField är en inline-nod och kan bara vara ett barn till Paragraf.

FormField representeras i ett dokument av ett specialtecken och placerat som ett tecken inom en textrad.

Ett komplett formulärfält i ett Word-dokument är en komplex struktur som representeras av flera noder: fältstart, fältkod som FORMTEXT, formulärfältsdata, fältavgränsare, fältresultat, fältslut och ett bokmärke. För att programmatiskt skapa formulärfält i ett Word-dokument use DocumentBuilder.InsertCheckBox , DocumentBuilder.InsertTextInput och DocumentBuilder.InsertComboBox which se till att alla formulärfältsnoder skapas i rätt ordning och i lämpligt tillstånd.

Exempel

Visar hur man formaterar hela FormField, inklusive fältvärdet.

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

Visar hur man infogar en kombinationsruta.

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

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

// Infoga en kombinationsruta som låter en användare välja ett alternativ från en samling strängar.
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);

// Formulärfältet kommer att visas i form av en "select" html-tagg.
doc.Save(ArtifactsDir + "FormFields.Create.html");

Se även