ChoiceField
Overview
ChoiceField is a class in Aspose.PDF FOSS for TypeScript.
Inherits from: Field.
A combo box or list box (/FT /Ch).
This class declares 7 methods for ChoiceField objects in TypeScript programs.
Available methods include: AddOption, Flatten, GenerateAppearance, RemoveOption, SetActions, SetStyle, constructor.
All public members are accessible to any TypeScript application after installing the Aspose.PDF FOSS for TypeScript package.
Properties: Actions, Combo, Editable, MultiSelect, Options, ReadOnly, and 4 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
Type | : 'choice' | Read | Gets the type. |
Combo | boolean | Read | Gets the combo. |
Editable | boolean | Read/Write | Gets the editable. |
MultiSelect | boolean | Read/Write | Gets the multi select. |
Widgets | PdfDict[] | Read | Gets the widgets. |
Options | string[] | Read | Gets the options. |
Value | string | string[] | boolean | Read/Write | Gets the value. |
Actions | FieldActions | Read | Gets the actions. |
ReadOnly | boolean | Read/Write | Gets the read only. |
Required | boolean | Read/Write | Gets the required. |
Methods
| Signature | Description |
|---|---|
AddOption(option: ChoiceOption) | Append an option to /Opt. |
RemoveOption(exportValue: string) | Remove the option exported as exportValue, keeping /V, /I and /TI consistent with the shortened list. |
constructor(doc: Document, acroForm: PdfDict, Dict: PdfDict, Name: string, FullName: string, Type: FieldType, ff: number, initialV: PdfObject) | Calls constructor(doc, acroForm, Dict, Name, FullName, Type, ff, initialV) on this ChoiceField instance. |
SetActions(actions: FieldActionsUpdate) | Set or clear /AA triggers. |
Flatten() → number | Bake just this field into static page content: draw each of its widgets’ appearances into their page’s /Contents, drop those widgets from /Annots, and unwire the field from /AcroForm /Fields. |
GenerateAppearance() | Regenerate this field’s appearance stream(s) from its current value, so the result renders without relying on a viewer honoring /NeedAppearances. |
SetStyle(style: FieldStyle) | Restyle this field: border, background and text. |