Interface IChoiceFormField

Base form field interface for all form fields that allow multiple choices.

Inherited Members

IFormField.AnnotationIDs

IFormField.Label

IFormField.Name

IFormField.NoExport

IFormField.PdfObjectId

IFormField.ReadOnly

IFormField.Required

Namespace: PSPDFKit.Pdf.Form

Assembly: PSPDFKit.dll

Syntax

public interface IChoiceFormField : IFormField

Properties

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

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

IList<string> DefaultValues { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<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

bool MultiSelect { get; set; }

Property Value

Type	Description
System.Boolean

Options

A list of FormOptions. This is necessary for multiple check boxes in a group.

Declaration

IList<FormOption> Options { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<FormOption>

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

IList<string> Values { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>