Class ComboBoxFormField
A combo box is a drop down box with the option to add custom entries. See Edit.
Inheritance
Namespace: PSPDFKit.Pdf.Form
Assembly: PSPDFKit.dll
Syntax
public sealed class ComboBoxFormField : IChoiceFormField, IFormFieldProperties
AnnotationIDs
A list of Id.
Declaration
public IList<string> AnnotationIDs { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
CommitOnChange
If true, the new value is committed as soon as a selection is made, without requiring the user to exit the field. Otherwise, the new value is not committed until the user exits the field. Default value is false.
Declaration
public bool CommitOnChange { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
DefaultValues
Similar to the Values property. The default values are only used when a form needs to be reset.
Declaration
public IList<string> DefaultValues { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
DoNotSpellCheck
If true, text entered in the field is not spell-checked. Default value is false.
Declaration
public bool DoNotSpellCheck { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Edit
If true, the combo box includes an editable text box as well as a drop-down list. Otherwise, it includes only a drop-down list. Default value is false.
Declaration
public bool Edit { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Label
Used to identify the form field in the UI or for accessibility.
Declaration
public string Label { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
MultiSelect
If true, more than one of the field’s option items may be selected simultaneously. Otherwise, no more than one item at a time may be selected. Default value is false.
Declaration
public bool MultiSelect { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Name
Unique name of the form field (often referred to as fully qualified name). This name is used to link Widget annotations and is also used as an identifier for form field values.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
NoExport
Determines if the form field will appear in the serialized payload of a form submission. Defaults to false.
Declaration
public bool NoExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Options
A list of FormOptions. This is necessary for multiple check boxes in a group.
Declaration
public IList<FormOption> Options { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<FormOption> |
PdfObjectId
The object ID of the form field object in the PDF.
Declaration
public int PdfObjectId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
ReadOnly
Read only form fields can not be filled out. Defaults to false.
Declaration
public bool ReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Required
Required form fields must be filled out in order to submit the form. Defaults to false.
Declaration
public bool Required { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Values
An immutable list of all selected form option values. If no options are defined, a checked check box will have values: List("Yes"). If the list is empty, no check box is checked.
Declaration
public IList<string> Values { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |