Implementation of the iText.Layout.Element.AbstractElement class for form fields. More...

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

Public Member Functions
virtual T	SetSize (float size)
	Sets the form field's width and height. More...

virtual IFormField	SetWidth (float width)
	Set the form field's width. More...

virtual IFormField	SetHeight (float height)
	Set the form field's height. More...

virtual IFormField	SetValue (String value)
	Sets the iText.Forms.Form.FormProperty.FORM_FIELD_VALUE property. More...

virtual String	GetId ()
	Gets the id. More...

override T1	GetDefaultProperty< T1 > (int property)
	Gets the default property from this entity. More...

virtual IFormField	SetInteractive (bool interactive)
	Set the form field to be interactive and added into Acroform instead of drawing it on a page. More...

virtual IFormField	SetAlternativeDescription (String alternativeDescription)
	Sets the form field's alternative description. More...

abstract AccessibilityProperties	GetAccessibilityProperties ()
	Gets the accessibility properties. More...

Public Member Functions inherited from iText.Layout.Element.AbstractElement< T >
virtual IRenderer	GetRenderer ()
	Gets a renderer for this element. More...

virtual void	SetNextRenderer (IRenderer renderer)
	Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More...

virtual IRenderer	CreateRendererSubTree ()
	Creates a renderer subtree with root in the current element. More...

override bool	HasProperty (int property)
	Checks if this entity has the specified property. More...

override T1	GetProperty< T1 > (int property)
	Gets the property from this entity. More...

virtual T	AddStyle (Style style)
	Add a new style to this element. More...

virtual IList< IElement >	GetChildren ()
	Gets the child elements of this elements More...

virtual bool	IsEmpty ()
	Returns `true` if this list contains no elements. More...

virtual T	SetAction (PdfAction action)
	Sets an action on this Element. More...

virtual T	SetPageNumber (int pageNumber)
	Explicitly sets the page number this element should be put on. More...

Public Member Functions inherited from iText.Layout.ElementPropertyContainer< T >
virtual void	SetProperty (int property, Object value)
	Sets a property for this entity. More...

virtual bool	HasOwnProperty (int property)
	Checks if this entity has the specified property, i.e. if it was set to this very element earlier More...

virtual void	DeleteOwnProperty (int property)
	Deletes the own property of this entity. More...

virtual T1	GetOwnProperty< T1 > (int property)
	Gets own property from this entity. More...

virtual T	SetRelativePosition (float left, float top, float right, float bottom)
	Sets values for a relative repositioning of the Element. More...

virtual T	SetFixedPosition (float left, float bottom, float width)
	Sets values for a absolute repositioning of the Element. More...

virtual T	SetFixedPosition (float left, float bottom, UnitValue width)
	Sets values for an absolute repositioning of the Element. More...

virtual T	SetFixedPosition (int pageNumber, float left, float bottom, float width)
	Sets values for a absolute repositioning of the Element. More...

virtual T	SetFixedPosition (int pageNumber, float left, float bottom, UnitValue width)
	Sets values for a absolute repositioning of the Element. More...

virtual T	SetHorizontalAlignment (HorizontalAlignment? horizontalAlignment)
	Sets the horizontal alignment of this Element. More...

virtual T	SetFont (PdfFont font)
	Sets the font of this Element. More...

virtual T	SetFontFamily (params String[] fontFamilyNames)
	Sets the preferable font families for this Element. More...

virtual T	SetFontFamily (IList< String > fontFamilyNames)
	Sets the preferable font families for this Element. More...

virtual T	SetFontColor (Color fontColor)
	Sets the font color of this Element. More...

virtual T	SetFontColor (Color fontColor, float opacity)
	Sets the font color of this Element and the opacity of the text. More...

virtual T	SetFontColor (TransparentColor transparentColor)

virtual T	SetFontSize (float fontSize)
	Sets the font size of this Element, measured in points. More...

virtual T	SetTextAlignment (TextAlignment? alignment)
	Sets the text alignment of this Element. More...

virtual T	SetCharacterSpacing (float charSpacing)
	Defines a custom spacing distance between all characters of a textual element. More...

virtual T	SetWordSpacing (float wordSpacing)
	Defines a custom spacing distance between words of a textual element. More...

virtual T	SetFontKerning (FontKerning fontKerning)
	Enable or disable kerning. More...

virtual T	SetBackgroundColor (Color backgroundColor)
	Specifies a background color for the Element. More...

virtual T	SetBackgroundColor (Color backgroundColor, float opacity)
	Specifies a background color for the Element. More...

virtual T	SetBackgroundColor (Color backgroundColor, float extraLeft, float extraTop, float extraRight, float extraBottom)
	Specifies a background color for the Element, and extra space that must be counted as part of the background and therefore colored. More...

virtual T	SetBackgroundColor (Color backgroundColor, float opacity, float extraLeft, float extraTop, float extraRight, float extraBottom)
	Specifies a background color for the Element, and extra space that must be counted as part of the background and therefore colored. More...

virtual T	SetBackgroundImage (BackgroundImage image)
	Specifies a background image for the Element. More...

virtual T	SetBackgroundImage (IList< BackgroundImage > imagesList)
	Specifies a list of background images for the Element. More...

virtual T	SetBorder (Border border)
	Sets a border for all four edges of this Element with customizable color, width, pattern type. More...

virtual T	SetBorderTop (Border border)
	Sets a border for the upper limit of this Element with customizable color, width, pattern type. More...

virtual T	SetBorderRight (Border border)
	Sets a border for the right limit of this Element with customizable color, width, pattern type. More...

virtual T	SetBorderBottom (Border border)
	Sets a border for the bottom limit of this Element with customizable color, width, pattern type. More...

virtual T	SetBorderLeft (Border border)
	Sets a border for the left limit of this Element with customizable color, width, pattern type. More...

virtual T	SetBorderRadius (BorderRadius borderRadius)
	Sets a border radius for all four edges of this Element. More...

virtual T	SetBorderBottomLeftRadius (BorderRadius borderRadius)
	Sets a border radius for the bottom left corner of this Element. More...

virtual T	SetBorderBottomRightRadius (BorderRadius borderRadius)
	Sets a border radius for the bottom right corner of this Element. More...

virtual T	SetBorderTopLeftRadius (BorderRadius borderRadius)
	Sets a border radius for the top left corner of this Element. More...

virtual T	SetBorderTopRightRadius (BorderRadius borderRadius)
	Sets a border radius for the top right corner of this Element. More...

virtual T	SetSplitCharacters (ISplitCharacters splitCharacters)
	Sets a rule for splitting strings when they don't fit into one line. More...

virtual ISplitCharacters	GetSplitCharacters ()
	Gets a rule for splitting strings when they don't fit into one line. More...

virtual ? int	GetTextRenderingMode ()
	Gets the text rendering mode, a variable that determines whether showing text causes glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three. More...

virtual T	SetTextRenderingMode (int textRenderingMode)
	Sets the text rendering mode, a variable that determines whether showing text causes glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three. More...

virtual Color	GetStrokeColor ()
	Gets the stroke color for the current element. More...

virtual TransparentColor	GetTransparentStrokeColor ()
	Gets the stroke color for the current element. More...

virtual T	SetStrokeColor (Color strokeColor)
	Sets the stroke color for the current element. More...

virtual T	SetStrokeColor (Color strokeColor, float opacity)
	Sets the stroke color for the current element. More...

virtual T	SetStrokeColor (TransparentColor transparentColor)
	Sets the stroke color for the current element. More...

virtual T	SetDashPattern (float[] dashArray, float dashPhase)
	Sets the stroke dash pattern for the current text. More...

virtual ? float	GetStrokeWidth ()
	Gets the stroke width for the current element. More...

virtual T	SetStrokeWidth (float strokeWidth)
	Sets the stroke width for the current element. More...

virtual T	SimulateBold ()
	Simulates bold style for a font. More...

virtual T	SimulateItalic ()
	Simulates italic style for a font. More...

virtual T	SetLineThrough ()
	Sets default line-through attributes for text. More...

virtual T	SetUnderline ()
	Sets default underline attributes for text. More...

virtual T	SetUnderline (float thickness, float yPosition)
	Sets an horizontal line that can be an underline or a strikethrough. More...

virtual T	SetUnderline (Color color, float thickness, float thicknessMul, float yPosition, float yPositionMul, int lineCapStyle)
	Sets an horizontal line that can be an underline or a strikethrough. More...

virtual T	SetUnderline (Color color, float opacity, float thickness, float thicknessMul, float yPosition, float yPositionMul, int lineCapStyle)
	Sets horizontal line that can be an underline or a strikethrough. More...

virtual T	SetUnderline (Underline underline)
	Sets horizontal line that can be an underline, overline or a strikethrough. More...

virtual T	SetBaseDirection (BaseDirection? baseDirection)
	This attribute specifies the base direction of directionally neutral text (i.e., text that doesn't have inherent directionality as defined in Unicode) in an element's content and attribute values. More...

virtual T	SetHyphenation (HyphenationConfig hyphenationConfig)
	Sets a custom hyphenation configuration which will hyphenate words automatically accordingly to the language and country. More...

virtual T	SetFontScript (UnicodeScript? script)
	Sets the writing system for this text element. More...

virtual T	SetDestination (String destination)
	Sets a destination name that will be created when this element is drawn to content. More...

virtual T	SetOpacity (float? opacity)
	Sets an opacity of the given element. More...

Package Attributes
DefaultAccessibilityProperties	tagProperties
	The tag properties. More...

Package Attributes inherited from iText.Layout.Element.AbstractElement< T >
IRenderer	nextRenderer

IList< IElement >	childElements = new List<IElement>()

ICollection< Style >	styles

Package Attributes inherited from iText.Layout.ElementPropertyContainer< T >
IDictionary< int, Object >	properties = new Dictionary()

Additional Inherited Members
Package Functions inherited from iText.Layout.Element.AbstractElement< T >
abstract IRenderer	MakeNewRenderer ()
	Creates a new renderer instance. More...

Detailed Description

Implementation of the iText.Layout.Element.AbstractElement class for form fields.

Template Parameters

T	the generic type of the form field (e.g. input field, button, text area)

Type Constraints

T

:

IFormField

Member Function Documentation

◆ GetAccessibilityProperties()

abstract AccessibilityProperties iText.Forms.Form.Element.FormField< T >.GetAccessibilityProperties ( )

pure virtual

Gets the accessibility properties.

Gets the accessibility properties . See also IAccessibleElement.

Returns: an interface that allows to specify properties of a tagged element in Tagged PDF.

Implements iText.Layout.Tagging.IAccessibleElement.

Implemented in iText.Forms.Form.Element.SignatureFieldAppearance, iText.Forms.Form.Element.InputField, iText.Forms.Form.Element.Button, iText.Forms.Form.Element.ComboBoxField, iText.Forms.Form.Element.ListBoxField, iText.Forms.Form.Element.CheckBox, iText.Forms.Form.Element.Radio, and iText.Forms.Form.Element.TextArea.

◆ GetDefaultProperty< T1 >()

override T1 iText.Forms.Form.Element.FormField< T >.GetDefaultProperty< T1 > ( int property )

inlinevirtual

Gets the default property from this entity.

Parameters

property

Gets the default property from this entity.

Returns

Gets the default property from this entity.

Reimplemented from iText.Layout.ElementPropertyContainer< T >.

◆ GetId()

virtual String iText.Forms.Form.Element.FormField< T >.GetId ( )

inlinevirtual

Gets the id.

Returns

Gets the id.

Implements iText.Forms.Form.Element.IFormField.

Reimplemented in iText.Forms.Form.Element.SignatureFieldAppearance.

◆ SetAlternativeDescription()

virtual IFormField iText.Forms.Form.Element.FormField< T >.SetAlternativeDescription ( String alternativeDescription )

inlinevirtual

Sets the form field's alternative description.

Parameters

alternativeDescription form field's alternative description.

Returns: this same FormField element.

◆ SetHeight()

virtual IFormField iText.Forms.Form.Element.FormField< T >.SetHeight ( float height )

inlinevirtual

Set the form field's height.

Parameters

height

Set the form field's height.

Returns

Set the form field's height.

Implements iText.Forms.Form.Element.IFormField.

◆ SetInteractive()

virtual IFormField iText.Forms.Form.Element.FormField< T >.SetInteractive ( bool interactive )

inlinevirtual

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

Parameters

interactive

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

Returns

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

Implements iText.Forms.Form.Element.IFormField.

◆ SetSize()

virtual T iText.Forms.Form.Element.FormField< T >.SetSize ( float size )

inlinevirtual

Sets the form field's width and height.

Parameters

size	form field's width and height.

Returns: this same FormField element.

Reimplemented in iText.Forms.Form.Element.CheckBox.

◆ SetValue()

virtual IFormField iText.Forms.Form.Element.FormField< T >.SetValue ( String value )

inlinevirtual

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

Parameters

value

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

Returns

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

Implements iText.Forms.Form.Element.IFormField.

Reimplemented in iText.Forms.Form.Element.Button.

◆ SetWidth()

virtual IFormField iText.Forms.Form.Element.FormField< T >.SetWidth ( float width )

inlinevirtual

Set the form field's width.

Parameters

width

Set the form field's width.

Returns

Set the form field's width.

Implements iText.Forms.Form.Element.IFormField.

Member Data Documentation

◆ tagProperties

DefaultAccessibilityProperties iText.Forms.Form.Element.FormField< T >.tagProperties

package

The tag properties.

Public Member Functions

Package Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAccessibilityProperties()

◆ GetDefaultProperty< T1 >()

◆ GetId()

◆ SetAlternativeDescription()

◆ SetHeight()

◆ SetInteractive()

◆ SetSize()

◆ SetValue()

◆ SetWidth()

Member Data Documentation

◆ tagProperties