Namespace: PdfSharp.Pdf.AcroForms
Specifies the flags of AcroForm fields.
public enum PdfAcroFieldFlags
Inheritance Object → ValueType → Enum → PdfAcroFieldFlags
Implements IComparable, IFormattable, IConvertible
| Name | Value | Description |
|---|---|---|
| ReadOnly | 1 | If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database. |
| Required | 2 | If set, the field must have a value at the time it is exported by a submit-form action. |
| NoExport | 4 | If set, the field must not be exported by a submit-form action. |
| Pushbutton | 65536 | If set, the field is a pushbutton that does not retain a permanent value. |
| Radio | 32768 | If set, the field is a set of radio buttons; if clear, the field is a checkbox. This flag is meaningful only if the Pushbutton flag is clear. |
| NoToggleToOff | 16384 | (Radio buttons only) If set, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected. |
| RadiosInUnison | 33554432 | (Radio buttons only) (PDF 1.5) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behaviour as HTML radio buttons). |
| Multiline | 4096 | If set, the field may contain multiple lines of text; if clear, the field’s text is restricted to a single line. |
| Password | 8192 | If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. To protect password confidentiality, viewer applications should never store the value of the text field in the PDF file if this flag is set. |
| FileSelect | 1048576 | (PDF 1.4) If set, the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field. |
| DoNotSpellCheckTextField | 4194304 | (PDF 1.4) If set, the text entered in the field will not be spell-checked. |
| DoNotScroll | 8388608 | (PDF 1.4) If set, the field will not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than will fit within its annotation rectangle. Once the field is full, no further text will be accepted. |
| CombTextField | 16777216 | (PDF 1.5) May be set only if the MaxLen entry is present in the text field dictionary (see “Table 232 — Additional entry specific to a text field”) and if the Multiline, Password, and FileSelect flags are clear. If set, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs. |
| RichTextTextField | 33554432 | (PDF 1.5) If set, the value of this field shall be a rich text string (see Adobe XML Architecture, XML Forms Architecture (XFA) Specification, version 3.3). If the field has a value, the RV entry of the field dictionary (“Table 228 — Additional entries common to all fields containing variable text”) shall specify the rich text string. |
| Combo | 131072 | If set, the field is a combo box; if clear, the field is a list box. |
| Edit | 262144 | If set, the combo box includes an editable text box as well as a drop list; if clear, it includes only a drop list. This flag is meaningful only if the Combo flag is set. |
| Sort | 524288 | If set, the field’s option items should be sorted alphabetically. This flag is intended for use by form authoring tools, not by PDF viewer applications; viewers should simply display the options in the order in which they occur in the Opt array. |
| MultiSelect | 2097152 | (PDF 1.4) If set, more than one of the field’s option items may be selected simultaneously; if clear, no more than one item at a time may be selected. |
| DoNotSpellCheckChoiceField | 4194304 | (PDF 1.4) If set, the text entered in the field will not be spell-checked. This flag is meaningful only if the Combo and Edit flags are both set. |
| CommitOnSelChangeChoiceField | 67108864 | (PDF 1.5) If set, the new value shall be committed as soon as a selection is made (commonly with the pointing device). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or “commits” the data choice and triggers any actions associated with the entry or changing of this data. If this flag is on, then processing does not wait for leaving the field action to occur, but immediately proceeds to the third step.This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field. |