FormField

FormField class

Representerar ett enda formulärfält.

För att lära dig mer, besökArbeta med formulärfält dokumentationsartikel.

public class FormField : SpecialChar

Egenskaper

namnBeskrivning
CalculateOnExit { get; set; }Sant om referenser till det angivna formulärfältet uppdateras automatiskt varje gång fältet lämnas.
CheckBoxSize { get; set; }Hämtar eller ställer in storleken på kryssrutan i punkter. Gäller endast närIsCheckBoxExactSize ärsann .
Checked { get; set; }Hämtar eller anger den markerade statusen för kryssrutefältet i formuläret. Standardvärdet för den här egenskapen ärfalsk .
CustomNodeId { get; set; }Anger anpassad nodidentifierare.
Default { get; set; }Hämtar eller ställer in standardvärdet för kryssrutefältet. Standardvärdet för den här egenskapen ärfalsk .
virtual Document { get; }Hämtar dokumentet som denna nod tillhör.
DropDownItems { get; }Ger åtkomst till objekten i ett rullgardinsmenyfält.
DropDownSelectedIndex { get; set; }Hämtar eller ställer in indexet som anger det valda objektet i ett rullgardinsmenyfält.
Enabled { get; set; }Sant om ett formulärfält är aktiverat.
EntryMacro { get; set; }Returnerar eller anger ett namn för ett postmakro för formulärfältet.
ExitMacro { get; set; }Returnerar eller anger ett avslutningsmakronamn för formulärfältet.
Font { get; }Ger åtkomst till teckensnittsformateringen för detta objekt.
HelpText { get; set; }Returnerar eller anger 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 anger om textrutans storlek är automatisk eller explicit angiven.
virtual IsComposite { get; }Returersann om denna nod kan innehålla andra noder.
IsDeleteRevision { get; }Returnerar sant om det här objektet togs bort i Microsoft Word medan ändringsspårning var aktiverad.
IsFormatRevision { get; }Returnerar sant om objektets formatering ä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; }Returersann om det här objektet flyttades (raderades) i Microsoft Word medan ändringsspårning var aktiverad.
IsMoveToRevision { get; }Returersann om det här objektet 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 anger formulärfältets namn.
NextSibling { get; }Hämtar noden som följer direkt efter denna nod.
override NodeType { get; }ReturerFormField .
OwnHelp { get; set; }Anger källan för 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 för 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 som omedelbart föregår denna nod.
Range { get; }Returnerar enRangeobjekt som representerar den del av ett dokument som finns i denna nod.
Result { get; set; }Hämtar eller anger en sträng som representerar resultatet av detta formulärfält.
StatusText { get; set; }Returnerar eller anger 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 anger textformateringen för ett textformulärfält.
TextInputType { get; set; }Hämtar eller anger typen av ett textformulärfält.
Type { get; }Returnerar formulärfältstypen.

Metoder

namnBeskrivning
override Accept(DocumentVisitor)Tar emot en besökare.
Clone(bool)Skapar en duplikat 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()Hämtar specialtecknet som denna nod representerar.
NextPreOrder(Node)Hämtar nästa nod enligt algoritmen för förbeställningsträdtraversering.
PreviousPreOrder(Node)Hämtar föregående nod enligt algoritmen för trädtraversering i förbeställning.
Remove()Tar bort sig själv från föräldern.
RemoveField()Tar bort hela formulärfältet, inte bara specialtecknet för formulärfältet.
SetTextInputValue(object)Tillämpar textformatet som anges iTextInputFormat och lagrar värdet iResult .
ToString(SaveFormat)Exporterar nodens innehåll till en sträng i det angivna formatet.
ToString(SaveOptions)Exporterar nodens innehåll till en sträng med de angivna sparalternativen.

Anmärkningar

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

FormField är en inline-nod och kan bara vara underordnadParagraph.

FormField representeras i ett dokument av ett specialtecken och placerat som ett tecken i 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ältdata, fältavgränsare, fältresultat, fältslut och ett bokmärke. För att programmatiskt skapa formulärfält i ett Word-dokument, använd InsertCheckBox , InsertTextInput och InsertComboBoxwhich 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