iText 8.0.5 API
iText.Forms.Form.Element.Radio Class Reference

Extension of the FormField class representing a radio button so that a iText.Forms.Form.Renderer.RadioRenderer is used instead of the default renderer for fields. More...

Inheritance diagram for iText.Forms.Form.Element.Radio:
iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.Radio >

Public Member Functions

  Radio (String id)
  Creates a new Radio instance. More...
 
  Radio (String id, String radioGroupName)
  Creates a new Radio instance. More...
 
virtual iText.Forms.Form.Element.Radio  SetChecked (bool @checked)
  Sets the state of the radio button. More...
 
override T1  GetProperty< T1 > (int property)
 
override AccessibilityProperties  GetAccessibilityProperties ()
  Gets the accessibility properties. More...
 
- Public Member Functions inherited from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.Radio >
virtual T  SetSize (float size)
  Sets the form field's width and height. More...
 
virtual IFormField  SetWidth (float width)
 
virtual IFormField  SetHeight (float height)
 
virtual IFormField  SetValue (String value)
 
virtual String  GetId ()
 
override T1  GetDefaultProperty< T1 > (int property)
 
virtual IFormField  SetInteractive (bool interactive)
 

Protected Member Functions

override IRenderer  MakeNewRenderer ()
 

Additional Inherited Members

- Package Attributes inherited from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.Radio >
DefaultAccessibilityProperties  tagProperties
  The tag properties. More...
 

Detailed Description

Extension of the FormField class representing a radio button so that a iText.Forms.Form.Renderer.RadioRenderer is used instead of the default renderer for fields.

Constructor & Destructor Documentation

◆ Radio() [1/2]

iText.Forms.Form.Element.Radio.Radio ( String  id )
inline

Creates a new Radio instance.

Parameters
id the id.

◆ Radio() [2/2]

iText.Forms.Form.Element.Radio.Radio ( String  id,
String  radioGroupName 
)
inline

Creates a new Radio instance.

Parameters
id the id.
radioGroupName the name of the radio group the radio button belongs to. It has sense only in case this Radio element will not be rendered but Acroform field will be created instead.

Member Function Documentation

◆ GetAccessibilityProperties()

override AccessibilityProperties iText.Forms.Form.Element.Radio.GetAccessibilityProperties ( )
inlinevirtual

◆ GetProperty< T1 >()

override T1 iText.Forms.Form.Element.Radio.GetProperty< T1 > ( int  property )
inline

◆ SetChecked()

virtual iText.Forms.Form.Element.Radio iText.Forms.Form.Element.Radio.SetChecked ( bool @  checked )
inlinevirtual

Sets the state of the radio button.

Parameters
checked

true if the radio button shall be checked, false otherwise. By default, the radio button is unchecked.

Returns
this same Radio button.