Class PdfButtonFormField

Namespace

iText.Forms.Fields

Assembly

itext.forms.dll

An interactive control on the screen that raises events and/or can retain data.

public class PdfButtonFormField : PdfFormField

Inheritance

object

PdfObjectWrapper<PdfDictionary>

AbstractPdfFormField

PdfFormField

PdfButtonFormField

Inherited Members

PdfFormField.FF_MULTILINE

PdfFormField.FF_PASSWORD

PdfFormField.FF_READ_ONLY

PdfFormField.FF_REQUIRED

PdfFormField.FF_NO_EXPORT

PdfFormField.text

PdfFormField.img

PdfFormField.form

PdfFormField.checkType

PdfFormField.MakeFormField(PdfObject, PdfDocument)

PdfFormField.MakeFormFieldOrAnnotation(PdfObject, PdfDocument)

PdfFormField.MakeFieldFlag(int)

PdfFormField.IsFormField(PdfDictionary)

PdfFormField.GetFormFieldKeys()

PdfFormField.GetFormType(PdfDictionary)

PdfFormField.SetValue(string)

PdfFormField.SetValue(string, bool)

PdfFormField.SetValue(string, PdfFont, float)

PdfFormField.SetValue(string, string)

PdfFormField.RemoveChild(AbstractPdfFormField)

PdfFormField.RemoveChildren()

PdfFormField.GetKids()

PdfFormField.GetChildFields()

PdfFormField.GetChildFormFields()

PdfFormField.GetAllChildFormFields()

PdfFormField.GetAllChildFields()

PdfFormField.GetChildField(string)

PdfFormField.AddKid(AbstractPdfFormField, bool)

PdfFormField.AddKid(PdfWidgetAnnotation)

PdfFormField.SetFieldName(string)

PdfFormField.GetPartialFieldName()

PdfFormField.SetAlternativeName(string)

PdfFormField.GetAlternativeName()

PdfFormField.SetMappingName(string)

PdfFormField.GetMappingName()

PdfFormField.GetFieldFlag(int)

PdfFormField.SetFieldFlag(int)

PdfFormField.SetFieldFlag(int, bool)

PdfFormField.IsMultiline()

PdfFormField.IsPassword()

PdfFormField.SetFieldFlags(int)

PdfFormField.GetFieldFlags()

PdfFormField.GetValue()

PdfFormField.GetValueAsString()

PdfFormField.GetDisplayValue()

PdfFormField.SetDefaultValue(PdfObject)

PdfFormField.GetDefaultValue()

PdfFormField.SetAdditionalAction(PdfName, PdfAction)

PdfFormField.GetAdditionalAction()

PdfFormField.SetOptions(PdfArray)

PdfFormField.GetOptions()

PdfFormField.GetWidgets()

PdfFormField.GetChildFormAnnotations()

PdfFormField.GetFirstFormAnnotation()

PdfFormField.GetDefaultAppearance()

PdfFormField.UpdateDefaultAppearance()

PdfFormField.GetJustification()

PdfFormField.SetJustification(TextAlignment?)

PdfFormField.GetDefaultStyle()

PdfFormField.SetDefaultStyle(PdfString)

PdfFormField.GetRichText()

PdfFormField.SetRichText(PdfObject)

PdfFormField.SetCheckType(CheckBoxType)

PdfFormField.RegenerateField()

PdfFormField.SetReadOnly(bool)

PdfFormField.IsReadOnly()

PdfFormField.SetRequired(bool)

PdfFormField.IsRequired()

PdfFormField.SetNoExport(bool)

PdfFormField.IsNoExport()

PdfFormField.IsInReadingMode()

PdfFormField.GetAppearanceStates()

PdfFormField.Release()

PdfFormField.SetColor(Color)

AbstractPdfFormField.DEFAULT_FONT_SIZE

AbstractPdfFormField.MIN_FONT_SIZE

AbstractPdfFormField.font

AbstractPdfFormField.fontSize

AbstractPdfFormField.color

AbstractPdfFormField.pdfAConformanceLevel

AbstractPdfFormField.pdfConformanceLevel

AbstractPdfFormField.parent

AbstractPdfFormField.GetPdfObject()

AbstractPdfFormField.SetParent(PdfFormField)

AbstractPdfFormField.GetParent()

AbstractPdfFormField.GetParentField()

AbstractPdfFormField.GetFieldName()

AbstractPdfFormField.GetFontSize()

AbstractPdfFormField.GetFont()

AbstractPdfFormField.GetColor()

AbstractPdfFormField.GetPdfAConformanceLevel()

AbstractPdfFormField.GetPdfConformanceLevel()

AbstractPdfFormField.DisableFieldRegeneration()

AbstractPdfFormField.EnableFieldRegeneration()

AbstractPdfFormField.DisableCurrentFieldRegeneration()

AbstractPdfFormField.EnableCurrentFieldRegeneration()

AbstractPdfFormField.IsFieldRegenerationEnabled()

AbstractPdfFormField.Put(PdfName, PdfObject)

AbstractPdfFormField.Remove(PdfName)

AbstractPdfFormField.GetDocument()

AbstractPdfFormField.IsWrappedObjectMustBeIndirect()

AbstractPdfFormField.SetFont(PdfFont)

AbstractPdfFormField.SetFontSize(float)

AbstractPdfFormField.SetFontSize(int)

AbstractPdfFormField.SetFontSizeAutoScale()

AbstractPdfFormField.SetFontAndSize(PdfFont, float)

AbstractPdfFormField.IsTerminalFormField()

AbstractPdfFormField.Equals(object)

AbstractPdfFormField.GetHashCode()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.Flush()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PdfButtonFormField(PdfWidgetAnnotation, PdfDocument)

Creates a button form field as a parent of a PdfWidgetAnnotation.

protected PdfButtonFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument)

Parameters

widget PdfWidgetAnnotation

The widget which will be a kid of the PdfButtonFormField.

pdfDocument PdfDocument

The PdfDocument instance.

PdfButtonFormField(PdfDictionary)

Creates a button form field as a wrapper object around a PdfDictionary.

protected PdfButtonFormField(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

the dictionary to be wrapped, must have an indirect reference.

Remarks

Creates a button form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

PdfButtonFormField(PdfDocument)

Creates a minimal PdfButtonFormField.

protected PdfButtonFormField(PdfDocument pdfDocument)

Parameters

pdfDocument PdfDocument

The PdfDocument instance.

Fields

FF_NO_TOGGLE_TO_OFF

If true, clicking the selected button deselects it, leaving no button selected.

public static readonly int FF_NO_TOGGLE_TO_OFF

Field Value

int

Remarks

If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times.

FF_PUSH_BUTTON

If true, the field is a push button that does not retain a permanent value.

public static readonly int FF_PUSH_BUTTON

Field Value

int

FF_RADIO

If true, the field is a set of radio buttons.

public static readonly int FF_RADIO

Field Value

int

Remarks

If true, the field is a set of radio buttons. If false, the field is a check box. This flag should be set only if the FF_PUSH_BUTTON flag is set to false.

FF_RADIOS_IN_UNISON

If true, a group of radio buttons within a radio button field, that use the same value for the on state will turn on and off in unison.

public static readonly int FF_RADIOS_IN_UNISON

Field Value

int

Remarks

If true, a group of radio buttons within a radio button field, that use the same value for the on state will turn on and off in unison. That is if one is checked, they are all checked. If false, the buttons are mutually exclusive.

Methods

AddKid(AbstractPdfFormField)

public override PdfFormField AddKid(AbstractPdfFormField kid)

Parameters

kid AbstractPdfFormField

Returns

PdfFormField

GetFormType()

Returns Btn, the form type for choice form fields.

public override PdfName GetFormType()

Returns

PdfName

the form type, as a PdfName

IsPushButton()

If true, the field is a pushbutton that does not retain a permanent value.

public virtual bool IsPushButton()

Returns

bool

whether or not the field is currently a pushbutton

IsRadio()

If true, the field is a set of radio buttons; if false, the field is a check box.

public virtual bool IsRadio()

Returns

bool

whether the field is currently radio buttons or a checkbox

Remarks

If true, the field is a set of radio buttons; if false, the field is a check box. This flag only works if the Pushbutton flag is set to false.

IsRadiosInUnison()

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.

public virtual bool IsRadiosInUnison()

Returns

bool

whether or not buttons are turned off in unison

Remarks

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If false, the buttons are mutually exclusive

IsToggleOff()

If true, clicking the selected button deselects it, leaving no button selected.

public virtual bool IsToggleOff()

Returns

bool

whether a radio button currently allows to choose no options

Remarks

If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times. Only valid for radio buttons.

SetImage(string)

Set image to be used as a background content in a push button.

public virtual PdfButtonFormField SetImage(string image)

Parameters

image string

path to the image to be used.

Returns

PdfButtonFormField

this PdfButtonFormField

SetImageAsForm(PdfFormXObject)

Set image to be used as a background content in a push button as PdfFormXObject.

public virtual PdfButtonFormField SetImageAsForm(PdfFormXObject form)

Parameters

form PdfFormXObject

PdfFormXObject to be used as an image

Returns

PdfButtonFormField

this PdfButtonFormField

SetPushButton(bool)

If true, the field is a pushbutton that does not retain a permanent value.

public virtual PdfButtonFormField SetPushButton(bool pushButton)

Parameters

pushButton bool

whether or not to set the field to a pushbutton

Returns

PdfButtonFormField

current PdfButtonFormField

SetRadio(bool)

If true, the field is a set of radio buttons; if false, the field is a check box.

public virtual PdfButtonFormField SetRadio(bool radio)

Parameters

radio bool

whether the field should be radio buttons or a checkbox

Returns

PdfButtonFormField

current PdfButtonFormField

Remarks

If true, the field is a set of radio buttons; if false, the field is a check box. This flag should be set only if the Pushbutton flag is set to false.

SetRadiosInUnison(bool)

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.

public virtual PdfButtonFormField SetRadiosInUnison(bool radiosInUnison)

Parameters

radiosInUnison bool

whether or not buttons should turn off in unison

Returns

PdfButtonFormField

current PdfButtonFormField

Remarks

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If false, the buttons are mutually exclusive

SetToggleOff(bool)

If true, clicking the selected button deselects it, leaving no button selected.

public virtual PdfButtonFormField SetToggleOff(bool toggleOff)

Parameters

toggleOff bool

whether a radio button may allow to choose no options

Returns

PdfButtonFormField

current PdfButtonFormField

Remarks

If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times.