Table of Contents

Enum PdfFormFieldFlags

Namespace
PdfSharp.Pdf.Forms
Assembly
PdfSharp.dll

Specifies the flags of interactive form (AcroForm) fields.

[Flags]
public enum PdfFormFieldFlags

Fields

CombTextField = 16777216

(PDF 1.5) May be set only if the MaxLen entry is present in the text field dictionary 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.

Combo = 131072

If set, the field is a combo box; if clear, the field is a list box.

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.

DoNotScroll = 8388608

(PDF 1.4) If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling; for non-interactive form filling, the filler should take care not to add more character than will visibly fit in the defined area.

DoNotSpellCheckChoiceField = 4194304

(PDF 1.4) If set, text entered in the field shall not be spell-checked. This flag shall not be used unless the Combo and Edit flags are both set.

DoNotSpellCheckTextField = 4194304

(PDF 1.4) If set, text entered in the field shall not be spell-checked.

Edit = 262144

If set, the combo box shall include an editable text box as well as a drop-down list; if clear, it shall include only a drop-down list. This flag shall be used only if the Combo flag is set.

FileSelect = 1048576

(PDF 1.4) If set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.

MultiSelect = 2097152

(PDF 1.4) If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected.

Multiline = 4096

If set, the field may contain multiple lines of text; if clear, the field’s text shall be restricted to a single line.

NoExport = 4

If set, the field shall not be exported by a submit-form action.

NoToggleToOff = 16384

(Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

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 shall instead be echoed in some unreadable form, such as asterisks or bullet characters. NOTE To protect password confidentiality, it is imperative that PDF processors never store the value of the text field in the PDF file if this flag is set.

Pushbutton = 65536

If set, the field is a push-button 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 check box. This flag may be set only if the Pushbutton flag is clear.

RadiosInUnison = 33554432

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

ReadOnly = 1

If set, an interactive PDF processor shall not allow a user to change the value of the field. Additionally, any associated widget annotations should not interact with the user; that is, they should not respond to mouse clicks nor change their appearance in response to mouse motions. NOTE: This flag is useful for fields whose values are computed or imported from a database.

Required = 2

If set, the field shall have a value at the time it is exported by a submit-form action.

RichTextTextField = 33554432

(PDF 1.5) If set, the value of this field shall be a rich text string. If the field has a value, the RV entry of the field dictionary shall specify the rich text string.

Sort = 524288

If set, the field’s option items shall be sorted alphabetically. This flag is intended for use by PDF writers, not by PDF readers. PDF readers shall display the options in the order in which they occur in the Opt array.