iText 8.0.5 API
iText.Forms.Form.Element.IFormField Interface Reference

Common interface for HTML form elements. More...

Inheritance diagram for iText.Forms.Form.Element.IFormField:
iText.Layout.Element.IBlockElement iText.Layout.Element.IAbstractElement iText.Layout.Element.IElement iText.Layout.IPropertyContainer iText.Forms.Form.Element.FormField< T >

Public Member Functions

IFormField  SetValue (String value)
  Sets the iText.Forms.Form.FormProperty.FORM_FIELD_VALUE property. More...
 
IFormField  SetInteractive (bool interactive)
  Set the form field to be interactive and added into Acroform instead of drawing it on a page. More...
 
String  GetId ()
  Gets the id. More...
 
IFormField  SetWidth (float width)
  Set the form field's width. More...
 
IFormField  SetHeight (float height)
  Set the form field's height. More...
 
- Public Member Functions inherited from iText.Layout.Element.IAbstractElement
IList< IElement GetChildren ()
  Gets the child elements of this elements. More...
 
- Public Member Functions inherited from iText.Layout.Element.IElement
void  SetNextRenderer (IRenderer renderer)
  Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More...
 
IRenderer  GetRenderer ()
  Gets a renderer for this element. More...
 
IRenderer  CreateRendererSubTree ()
  Creates a renderer subtree with root in the current element. More...
 
- Public Member Functions inherited from iText.Layout.IPropertyContainer
bool  HasProperty (int property)
  Checks if this entity has the specified property. More...
 
bool  HasOwnProperty (int property)
  Checks if this entity has the specified property, i.e. if it was set to this very element earlier More...
 
T1  GetProperty< T1 > (int property)
  Gets the property from this entity. More...
 
T1  GetOwnProperty< T1 > (int property)
  Gets own property from this entity. More...
 
T1  GetDefaultProperty< T1 > (int property)
  Gets the default property from this entity. More...
 
void  SetProperty (int property, Object value)
  Sets a property for this entity. More...
 
void  DeleteOwnProperty (int property)
  Deletes the own property of this entity. More...
 

Detailed Description

Common interface for HTML form elements.

Member Function Documentation

◆ GetId()

String iText.Forms.Form.Element.IFormField.GetId ( )

Gets the id.

Returns
the id.

Implemented in iText.Forms.Form.Element.FormField< T >.

◆ SetHeight()

IFormField iText.Forms.Form.Element.IFormField.SetHeight ( float  height )

Set the form field's height.

Parameters
height form field's height.
Returns
this FormField element.

Implemented in iText.Forms.Form.Element.FormField< T >.

◆ SetInteractive()

IFormField iText.Forms.Form.Element.IFormField.SetInteractive ( bool  interactive )

Set the form field to be interactive and added into Acroform instead of drawing it on a page.

Parameters
interactive

true if the form field element shall be added into Acroform, false otherwise. By default, the form field element is not interactive and drawn on a page.

Returns
this same IFormField instance.

Implemented in iText.Forms.Form.Element.FormField< T >.

◆ SetValue()

IFormField iText.Forms.Form.Element.IFormField.SetValue ( String  value )

Sets the iText.Forms.Form.FormProperty.FORM_FIELD_VALUE property.

Parameters
value string value of the property to be set.
Returns
this same IFormField instance.

Implemented in iText.Forms.Form.Element.FormField< T >.

◆ SetWidth()

IFormField iText.Forms.Form.Element.IFormField.SetWidth ( float  width )

Set the form field's width.

Parameters
width form field's width.
Returns
this FormField element.

Implemented in iText.Forms.Form.Element.FormField< T >.