Interface ICheckableFormField
Inherited Members
Namespace: IronSoftware.Forms
Assembly: IronPdf.dll
Syntax
public interface ICheckableFormField : IFormField, IFormFieldObject, IFormFieldAnnotationObject, IPdfDocumentObject
Working with PDF forms through a shared contract runs through ICheckableFormField. It is the IronPDF contract for PDF forms, so code can work with PDF forms uniformly across implementors rather than binding to a concrete type.
Concrete implementors include CheckboxFormField, RadioFormField. Code that accepts ICheckableFormField works uniformly across these implementors, so applications can read or configure C# PDF features without binding to a specific concrete type.
Most of the usable surface is inherited. The members that carry everyday use of this contract are SetDefaultFont(String, Int32, Color), Annotations, Choices, DefaultAppearance; consult these first when implementing or consuming ICheckableFormField. The create forms walks through typical use in the IronPDF C# documentation.
using IronPdf;
// ICheckableFormField is consumed as the API surface for the family of implementors
void Consume(ICheckableFormField target)
{
// Use members defined on the interface; concrete behavior follows the implementor
}For collection-wide operations and end-to-end examples, see the IronPDF C# documentation for related guides. For collection-wide operations on ICheckableFormField instances, the IronPDF C# documentation lists the relevant container types and their methods. Concrete behavior depends on which implementor of ICheckableFormField is returned at runtime; consult the specific class reference for type-specific members. Polymorphic access through ICheckableFormField lets code work uniformly across the family of implementors, with a cast required only when type-specific behavior is needed. The reference tables below list the full set of members defined on ICheckableFormField along with any inherited members exposed through the contract. In a typical IronPDF C# workflow, ICheckableFormField appears as a parameter or return type at the boundary between the application and the IronPDF API. See the methods table below for the complete set of members defined directly on ICheckableFormField. Implementing ICheckableFormField directly in application code is uncommon; the typical pattern is to consume instances returned from the IronPDF API.
Properties
SelectedIndex
Currently selected index
Declaration
int SelectedIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
Clear()
Clear any and all selected values
Declaration
void Clear()
Select(Int32)
Select the value at the specified index
If no index is provided, selects the first value. If there are more than one options, throws an exception
Declaration
string Select(int index = -1)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index to select |
Returns
| Type | Description |
|---|---|
| System.String | Value at the selected index |
Exceptions
| Type | Condition |
|---|---|
| System.Exception | No index was provided and there is more than one selectable option |