PdfRadioButtonListField

12 Sep 20255 minutes to read

PdfRadioButtonListField class represents the radio button field objects.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0);
// Access the PDF form
let form: PdfForm = document.form;
// Create a new radio button list field
let field: PdfRadioButtonListField = new PdfRadioButtonListField(page, 'Age');
// Create and add first item
let first: PdfRadioButtonListItem = field.add('1-9', {x: 100, y: 140, width: 20, height: 20});
// Create and add second item
let second: PdfRadioButtonListItem = new PdfRadioButtonListItem('10-49', {x: 100, y: 170, width: 20, height: 20}, page);
field.add(second);
// Sets selected index of the radio button list field
field.selectedIndex = 0;
// Add the field into PDF form
form.add(field);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

allowUnisonSelection boolean

Gets a value that specifies whether multiple radio buttons in the same group can be selected simultaneously within the form.

backColor number[]

Gets the background color of the field.

border PdfInteractiveBorder

Gets the width, style and dash of the border of the field.

borderColor number[]

Gets the border color of the field.

bounds Object

Gets the bounds.

checked boolean

Gets the flag indicating whether the field is checked or not (Read only).

color number[]

Gets the fore color of the field.

export boolean

Gets a value indicating whether the field is allow to export data or not.

flatten boolean

Gets the boolean flag indicating whether the form field have been flattened or not.

form PdfForm

Gets the form object of the field (Read only).

itemsCount number

Gets the count of the loaded field items (Read only).

mappingName string

Gets the mapping name to be used when exporting interactive form field data from the document.

name string

Gets the name of the field (Read only).

page PdfPage

Gets the page object of the form field (Read only).

readOnly boolean

Gets a value indicating whether read only.

required boolean

Gets a value indicating whether the field is required.

rotate number

Gets the rotation angle of the field.

rotationAngle PdfRotationAngle

Gets the rotation of the field (Read only).

selectedIndex number

Gets the selected item index.

tabIndex number

Gets the tab index of annotation in current page.

toolTip string

Gets the tool tip of the form field.

visibility PdfFormFieldVisibility

Gets the form field visibility.

visible boolean

Gets a value indicating the visibility of the field (Read only).

Methods

add

Add list item to the field.

Parameter	Type	Description
item	PdfRadioButtonListItem	List item.

Returns number

add

Add list item to the field.

Parameter	Type	Description
value	string	Name of the list item.
bounds	Object	Bounds of the list item.

Returns PdfRadioButtonListItem

getValue

Gets the value associated with the specified key.

Parameter	Type	Description
name	string	Key.

Returns string

itemAt

Gets the item at the specified index.

Parameter	Type	Description
index	number	Index of the field item.

Returns PdfRadioButtonListItem

removeItem

Remove the specified radio button list field item.

Parameter	Type	Description
item	PdfRadioButtonListItem	Item to remove.

Returns void

removeItemAt

Remove the radio button list item from the specified index.

Parameter	Type	Description
index	number	Item index to remove.

Returns void

setAppearance

Sets the flag to indicate the new appearance creation.

Parameter	Type	Description
value	boolean	Set appearance.

Returns void

setValue

Sets the value associated with the specified key.

Parameter	Type	Description
name	string	Key.
value	string	Value associated with the key..

Returns void