iText 9.6.0 API
iText.Forms.Form.Element.CheckBox Class Reference

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

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

Public Member Functions

  CheckBox (String id)
  Creates a new CheckBox instance. More...
 
virtual iText.Forms.Form.Element.CheckBox  SetChecked (bool @checked)
  Sets the checked state of the checkbox. More...
 
virtual iText.Forms.Form.Element.CheckBox  SetPdfConformance (PdfConformance conformance)
  Sets the conformance for the checkbox. More...
 
virtual iText.Forms.Form.Element.CheckBox  SetCheckBoxType (CheckBoxType checkBoxType)
  Sets the icon of the checkbox. More...
 
override iText.Forms.Form.Element.CheckBox  SetSize (float size)
  Sets the size of the checkbox. More...
 
override AccessibilityProperties  GetAccessibilityProperties ()
  Gets the accessibility properties. More...
 
- Public Member Functions inherited from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.CheckBox >
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)
 
virtual IFormField  SetAlternativeDescription (String alternativeDescription)
  Sets the form field's alternative description. More...
 

Protected Member Functions

override IRenderer  MakeNewRenderer ()
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

◆ CheckBox()

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

Creates a new CheckBox instance.

Parameters
id the id

Member Function Documentation

◆ GetAccessibilityProperties()

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

◆ SetCheckBoxType()

virtual iText.Forms.Form.Element.CheckBox iText.Forms.Form.Element.CheckBox.SetCheckBoxType ( CheckBoxType  checkBoxType )
inlinevirtual

Sets the icon of the checkbox.

Parameters
checkBoxType the type of the checkbox to set
Returns
this checkbox instance

◆ SetChecked()

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

Sets the checked state of the checkbox.

Parameters
checked the checked state to set
Returns
this checkbox instance

◆ SetPdfConformance()

virtual iText.Forms.Form.Element.CheckBox iText.Forms.Form.Element.CheckBox.SetPdfConformance ( PdfConformance  conformance )
inlinevirtual

Sets the conformance for the checkbox.

Parameters
conformance The PDF conformance to set.
Returns
this checkbox instance

◆ SetSize()

override iText.Forms.Form.Element.CheckBox iText.Forms.Form.Element.CheckBox.SetSize ( float  size )
inlinevirtual

Sets the size of the checkbox.

Parameters
size the size of the checkbox to set, in points
Returns
this checkbox instance

Reimplemented from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.CheckBox >.