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

Extension of the FormField class representing a button so that a iText.Forms.Form.Renderer.InputFieldRenderer is used. More...

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

Public Member Functions

  InputField (String id)
  Creates a new input field. More...
 
virtual iText.Forms.Form.Element.InputField  UseAsPassword (bool isPassword)
  Determines, whether the input field will be password. More...
 
virtual Paragraph  GetPlaceholder ()
  Gets the placeholder paragraph. More...
 
virtual void  SetPlaceholder (Paragraph placeholder)
  Sets the placeholder paragraph. More...
 
override T1  GetDefaultProperty< T1 > (int property)
 
virtual int  GetRotation ()
  Get rotation. More...
 
virtual iText.Forms.Form.Element.InputField  SetRotation (int rotation)
  Set rotation of the input field. More...
 
override AccessibilityProperties  GetAccessibilityProperties ()
  Gets the accessibility properties. More...
 
- Public Member Functions inherited from iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.InputField >
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.InputField >
DefaultAccessibilityProperties  tagProperties
  The tag properties. More...
 

Detailed Description

Extension of the FormField class representing a button so that a iText.Forms.Form.Renderer.InputFieldRenderer is used.

Constructor & Destructor Documentation

◆ InputField()

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

Creates a new input field.

Parameters
id the id

Member Function Documentation

◆ GetAccessibilityProperties()

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

◆ GetPlaceholder()

virtual Paragraph iText.Forms.Form.Element.InputField.GetPlaceholder ( )
inlinevirtual

Gets the placeholder paragraph.

Implements iText.Forms.Form.Element.IPlaceholderable.

◆ GetRotation()

virtual int iText.Forms.Form.Element.InputField.GetRotation ( )
inlinevirtual

Get rotation.

Returns
rotation value.

◆ SetPlaceholder()

virtual void iText.Forms.Form.Element.InputField.SetPlaceholder ( Paragraph  placeholder )
inlinevirtual

Sets the placeholder paragraph.

Implements iText.Forms.Form.Element.IPlaceholderable.

◆ SetRotation()

virtual iText.Forms.Form.Element.InputField iText.Forms.Form.Element.InputField.SetRotation ( int  rotation )
inlinevirtual

Set rotation of the input field.

Parameters
rotation new rotation value, counterclockwise. Must be a multiple of 90 degrees. It has sense only in interactive mode, see FormField.SetInteractive(bool).
Returns
the edited InputField.

◆ UseAsPassword()

virtual iText.Forms.Form.Element.InputField iText.Forms.Form.Element.InputField.UseAsPassword ( bool  isPassword )
inlinevirtual

Determines, whether the input field will be password.

Determines, whether the input field will be password.

Usually means that instead of glyphs '*' will be shown in case of flatten field.

If the field is not flatten, value will be ignored.

Parameters
isPassword

true is this field shall be considered as password, false otherwise

Returns
this input field