iText.Forms.Form.Element.Button Class Reference

Extension of the FormField class representing a button in html. More...

Inheritance diagram for iText.Forms.Form.Element.Button:

Public Member Functions
	Button (String id)
	Creates a new Button instance. More...
virtual iText.Forms.Form.Element.Button	Add (IBlockElement element)
	Adds any block element to the div's contents. More...
virtual iText.Forms.Form.Element.Button	Add (Image element)
	Adds an image to the div's contents. More...
virtual bool	IsSingleLine ()
	Indicates if this element represents an input with type button in html. More...
virtual iText.Forms.Form.Element.Button	SetSingleLineValue (String value)
	Sets passed string value to the single line button caption. More...
override IFormField	SetValue (String value)
	Adds passed string value as paragraph to the button. More...
override T1	GetDefaultProperty< 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.Button >
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 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.Button >
DefaultAccessibilityProperties	tagProperties
	The tag properties. More...

Detailed Description

Extension of the FormField class representing a button in html.

Constructor & Destructor Documentation

Button()

iText.Forms.Form.Element.Button.Button ( String  id )

inline

Creates a new Button instance.

Parameters

id

the id

Member Function Documentation

Add() [1/2]

virtual iText.Forms.Form.Element.Button iText.Forms.Form.Element.Button.Add ( IBlockElement  element )

inlinevirtual

Adds any block element to the div's contents.

Parameters

element

a iText.Layout.Element.BlockElement

Returns

this Element

Add() [2/2]

virtual iText.Forms.Form.Element.Button iText.Forms.Form.Element.Button.Add ( Image  element )

inlinevirtual

Adds an image to the div's contents.

Parameters

element

an iText.Layout.Element.Image

Returns

this Element

GetAccessibilityProperties()

override AccessibilityProperties iText.Forms.Form.Element.Button.GetAccessibilityProperties ( )

inlinevirtual

Gets the accessibility properties.

Implements iText.Forms.Form.Element.FormField< iText.Forms.Form.Element.Button >.

GetDefaultProperty< T1 >()

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

inline

Returns

IsSingleLine()

virtual bool iText.Forms.Form.Element.Button.IsSingleLine ( )

inlinevirtual

Indicates if this element represents an input with type button in html.

Returns

true if it's the button with only one line caption.

MakeNewRenderer()

override IRenderer iText.Forms.Form.Element.Button.MakeNewRenderer ( )

inlineprotected

Returns

SetSingleLineValue()

virtual iText.Forms.Form.Element.Button iText.Forms.Form.Element.Button.SetSingleLineValue ( String  value )

inlinevirtual

Sets passed string value to the single line button caption.

Sets passed string value to the single line button caption. Value will be clipped if it is not fit into single line. For multiple line value use SetValue(System.String) . Note that when adding other elements to the button after this method is called, this added value can be multiline.

Parameters

value

string value to be set as caption.

Returns

this same Button instance.

SetValue()

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

inlinevirtual

Adds passed string value as paragraph to the button.

Adds passed string value as paragraph to the button. Value can be multiline if it is not fit into single line. For single line value use SetSingleLineValue(System.String) . Note that the new value will replace all already added elements.

Parameters

value

string value to be added into button.

Returns

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