Class Button

Namespace

iText.Forms.Form.Element

Assembly

itext.forms.dll

Extension of the FormField<T> class representing a button in html.

public class Button : FormField<Button>, IFormField, IBlockElement, IAbstractElement, IElement, IPropertyContainer, IAccessibleElement

Inheritance

object

ElementPropertyContainer<Button>

AbstractElement<Button>

FormField<Button>

Button

Implements

IFormField

IBlockElement

IAbstractElement

IElement

IPropertyContainer

IAccessibleElement

Inherited Members

FormField<Button>.tagProperties

FormField<Button>.SetSize(float)

FormField<Button>.SetWidth(float)

FormField<Button>.SetHeight(float)

FormField<Button>.GetId()

FormField<Button>.SetInteractive(bool)

AbstractElement<Button>.nextRenderer

AbstractElement<Button>.childElements

AbstractElement<Button>.styles

AbstractElement<Button>.GetRenderer()

AbstractElement<Button>.SetNextRenderer(IRenderer)

AbstractElement<Button>.CreateRendererSubTree()

AbstractElement<Button>.HasProperty(int)

AbstractElement<Button>.GetProperty<T1>(int)

AbstractElement<Button>.AddStyle(Style)

AbstractElement<Button>.GetChildren()

AbstractElement<Button>.IsEmpty()

AbstractElement<Button>.SetAction(PdfAction)

AbstractElement<Button>.SetPageNumber(int)

ElementPropertyContainer<Button>.properties

ElementPropertyContainer<Button>.SetProperty(int, object)

ElementPropertyContainer<Button>.HasOwnProperty(int)

ElementPropertyContainer<Button>.DeleteOwnProperty(int)

ElementPropertyContainer<Button>.GetOwnProperty<T1>(int)

ElementPropertyContainer<Button>.SetRelativePosition(float, float, float, float)

ElementPropertyContainer<Button>.SetFixedPosition(float, float, float)

ElementPropertyContainer<Button>.SetFixedPosition(float, float, UnitValue)

ElementPropertyContainer<Button>.SetFixedPosition(int, float, float, float)

ElementPropertyContainer<Button>.SetFixedPosition(int, float, float, UnitValue)

ElementPropertyContainer<Button>.SetHorizontalAlignment(HorizontalAlignment?)

ElementPropertyContainer<Button>.SetFont(PdfFont)

ElementPropertyContainer<Button>.SetFontFamily(params string[])

ElementPropertyContainer<Button>.SetFontFamily(IList<string>)

ElementPropertyContainer<Button>.SetFontColor(Color)

ElementPropertyContainer<Button>.SetFontColor(Color, float)

ElementPropertyContainer<Button>.SetFontColor(TransparentColor)

ElementPropertyContainer<Button>.SetFontSize(float)

ElementPropertyContainer<Button>.SetTextAlignment(TextAlignment?)

ElementPropertyContainer<Button>.SetCharacterSpacing(float)

ElementPropertyContainer<Button>.SetWordSpacing(float)

ElementPropertyContainer<Button>.SetFontKerning(FontKerning)

ElementPropertyContainer<Button>.SetBackgroundColor(Color)

ElementPropertyContainer<Button>.SetBackgroundColor(Color, float)

ElementPropertyContainer<Button>.SetBackgroundColor(Color, float, float, float, float)

ElementPropertyContainer<Button>.SetBackgroundColor(Color, float, float, float, float, float)

ElementPropertyContainer<Button>.SetBackgroundImage(BackgroundImage)

ElementPropertyContainer<Button>.SetBackgroundImage(IList<BackgroundImage>)

ElementPropertyContainer<Button>.SetBorder(Border)

ElementPropertyContainer<Button>.SetBorderTop(Border)

ElementPropertyContainer<Button>.SetBorderRight(Border)

ElementPropertyContainer<Button>.SetBorderBottom(Border)

ElementPropertyContainer<Button>.SetBorderLeft(Border)

ElementPropertyContainer<Button>.SetBorderRadius(BorderRadius)

ElementPropertyContainer<Button>.SetBorderBottomLeftRadius(BorderRadius)

ElementPropertyContainer<Button>.SetBorderBottomRightRadius(BorderRadius)

ElementPropertyContainer<Button>.SetBorderTopLeftRadius(BorderRadius)

ElementPropertyContainer<Button>.SetBorderTopRightRadius(BorderRadius)

ElementPropertyContainer<Button>.SetSplitCharacters(ISplitCharacters)

ElementPropertyContainer<Button>.GetSplitCharacters()

ElementPropertyContainer<Button>.GetTextRenderingMode()

ElementPropertyContainer<Button>.SetTextRenderingMode(int)

ElementPropertyContainer<Button>.GetStrokeColor()

ElementPropertyContainer<Button>.SetStrokeColor(Color)

ElementPropertyContainer<Button>.GetStrokeWidth()

ElementPropertyContainer<Button>.SetStrokeWidth(float)

ElementPropertyContainer<Button>.SetBold()

ElementPropertyContainer<Button>.SetItalic()

ElementPropertyContainer<Button>.SetLineThrough()

ElementPropertyContainer<Button>.SetUnderline()

ElementPropertyContainer<Button>.SetUnderline(float, float)

ElementPropertyContainer<Button>.SetUnderline(Color, float, float, float, float, int)

ElementPropertyContainer<Button>.SetUnderline(Color, float, float, float, float, float, int)

ElementPropertyContainer<Button>.SetBaseDirection(BaseDirection?)

ElementPropertyContainer<Button>.SetHyphenation(HyphenationConfig)

ElementPropertyContainer<Button>.SetFontScript(UnicodeScript?)

ElementPropertyContainer<Button>.SetDestination(string)

ElementPropertyContainer<Button>.SetOpacity(float?)

Constructors

Button(string)

Creates a new Button instance.

public Button(string id)

Parameters

id string

the id

Methods

Add(IBlockElement)

Adds any block element to the div's contents.

public virtual Button Add(IBlockElement element)

Parameters

element IBlockElement

a BlockElement<T>

Returns

Button

this Element

Add(Image)

Adds an image to the div's contents.

public virtual Button Add(Image element)

Parameters

element Image

an Image

Returns

Button

this Element

GetAccessibilityProperties()

public override AccessibilityProperties GetAccessibilityProperties()

Returns

AccessibilityProperties

GetDefaultProperty<T1>(int)

public override T1 GetDefaultProperty<T1>(int property)

Parameters

property int

Returns

T1

Type Parameters

T1

IsSingleLine()

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

public virtual bool IsSingleLine()

Returns

bool

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

MakeNewRenderer()

protected override IRenderer MakeNewRenderer()

Returns

IRenderer

SetSingleLineValue(string)

Sets passed string value to the single line button caption.

public virtual Button SetSingleLineValue(string value)

Parameters

value string

string value to be set as caption.

Returns

Button

this same Button instance.

Remarks

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(string) . Note that when adding other elements to the button after this method is called, this added value can be multiline.

SetValue(string)

Adds passed string value as paragraph to the button.

public override IFormField SetValue(string value)

Parameters

value string

string value to be added into button.

Returns

IFormField

Remarks

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(string) . Note that the new value will replace all already added elements.