iText.Forms.FormDefaultAccessibilityProperties Class Reference

The FormDefaultAccessibilityProperties class is used to create a specific forms related instance of the iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties class. More...

Inheritance diagram for iText.Forms.FormDefaultAccessibilityProperties:

Public Member Functions
	FormDefaultAccessibilityProperties (String formFieldType)
	Instantiates a new FormDefaultAccessibilityProperties instance based on structure element role. More...
virtual void	UpdateCheckedValue (IPropertyContainer element)
	Updates the checked value of the form field based on the iText.Forms.Form.FormProperty.FORM_FIELD_CHECKED property. More...
Public Member Functions inherited from iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties
	DefaultAccessibilityProperties (String role)
	Instantiates a new DefaultAccessibilityProperties instance based on structure element role. More...
override String	GetRole ()
	Gets the role of element. More...
override AccessibilityProperties	SetRole (String role)
	Sets the role of element. More...
override String	GetLanguage ()
	Gets the language identifier of element. More...
override AccessibilityProperties	SetLanguage (String language)
	Sets the language identifier of element. More...
override String	GetActualText ()
	Gets the actual text of element. More...
override AccessibilityProperties	SetActualText (String actualText)
	Sets the actual text of element. More...
override String	GetAlternateDescription ()
	Gets the alternate description of element. More...
override AccessibilityProperties	SetAlternateDescription (String alternateDescription)
	Sets the alternate description of element. More...
override String	GetExpansion ()
	Gets the expansion of element. More...
override AccessibilityProperties	SetExpansion (String expansion)
	Sets the expansion of element. More...
override AccessibilityProperties	AddAttributes (PdfStructureAttributes attributes)
	Adds the attributes to the element. More...
override AccessibilityProperties	AddAttributes (int index, PdfStructureAttributes attributes)
	Adds the attributes to the element with specified index. More...
override AccessibilityProperties	ClearAttributes ()
	Clears the list of attributes. More...
override IList< PdfStructureAttributes >	GetAttributesList ()
	Gets the attributes list. More...
override String	GetPhoneme ()
	Gets the phoneme of element. More...
override AccessibilityProperties	SetPhoneme (String phoneme)
	Sets the phoneme of element. More...
override String	GetPhoneticAlphabet ()
	Gets the phonetic alphabet of element. More...
override AccessibilityProperties	SetPhoneticAlphabet (String phoneticAlphabet)
	Sets the phonetic alphabet of element. More...
override PdfNamespace	GetNamespace ()
	Gets the namespace of element. More...
override AccessibilityProperties	SetNamespace (PdfNamespace @namespace)
	Sets the namespace of element. More...
override AccessibilityProperties	AddRef (TagTreePointer treePointer)
	Adds the reference to other tagged element. More...
override IList< TagTreePointer >	GetRefsList ()
	Gets the list of references to other tagged elements. More...
override AccessibilityProperties	ClearRefs ()
	Clears the list of references to other tagged elements. More...
override byte[]	GetStructureElementId ()
	Gets the associated structure element's ID string, if it has one. More...
override AccessibilityProperties	SetStructureElementId (byte[] id)
	Sets the associated structure element's ID. More...
Public Member Functions inherited from iText.Kernel.Pdf.Tagutils.AccessibilityProperties
virtual AccessibilityProperties	SetStructureElementIdString (String id)
	Sets the associated structure element's ID. More...

Static Public Attributes
const String	FORM_FIELD_RADIO = "rb"
	Represents the role: radio. More...
const String	FORM_FIELD_CHECK = "cb"
	Represents the role: Checkbox. More...
const String	FORM_FIELD_PUSH_BUTTON = "pb"
	Represents the role: PushButton. More...
const String	FORM_FIELD_LIST_BOX = "lb"
	Represents the role: ListBox. More...
const String	FORM_FIELD_TEXT = "tv"
	Represents the role: Text. More...

Additional Inherited Members
Package Attributes inherited from iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties
String	role
String	language
String	actualText
String	alternateDescription
String	expansion
IList< PdfStructureAttributes >	attributesList = new List<PdfStructureAttributes>()
String	phoneme
String	phoneticAlphabet
IList< TagTreePointer >	refs = new List<TagTreePointer>()

Detailed Description

The FormDefaultAccessibilityProperties class is used to create a specific forms related instance of the iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties class.

Constructor & Destructor Documentation

FormDefaultAccessibilityProperties()

iText.Forms.FormDefaultAccessibilityProperties.FormDefaultAccessibilityProperties ( String  formFieldType )

inline

Instantiates a new FormDefaultAccessibilityProperties instance based on structure element role.

Parameters

formFieldType

the type of the formField

Member Function Documentation

UpdateCheckedValue()

virtual void iText.Forms.FormDefaultAccessibilityProperties.UpdateCheckedValue ( IPropertyContainer  element )

inlinevirtual

Updates the checked value of the form field based on the iText.Forms.Form.FormProperty.FORM_FIELD_CHECKED property.

Updates the checked value of the form field based on the iText.Forms.Form.FormProperty.FORM_FIELD_CHECKED property. If no such property is found, the checked value is set to "off".

Parameters

element

The element which contains a iText.Forms.Form.FormProperty.FORM_FIELD_CHECKED property.

Member Data Documentation

FORM_FIELD_CHECK

const String iText.Forms.FormDefaultAccessibilityProperties.FORM_FIELD_CHECK = "cb"

static

Represents the role: Checkbox.

FORM_FIELD_LIST_BOX

const String iText.Forms.FormDefaultAccessibilityProperties.FORM_FIELD_LIST_BOX = "lb"

static

Represents the role: ListBox.

FORM_FIELD_PUSH_BUTTON

const String iText.Forms.FormDefaultAccessibilityProperties.FORM_FIELD_PUSH_BUTTON = "pb"

static

Represents the role: PushButton.

FORM_FIELD_RADIO

const String iText.Forms.FormDefaultAccessibilityProperties.FORM_FIELD_RADIO = "rb"

static

Represents the role: radio.

FORM_FIELD_TEXT

const String iText.Forms.FormDefaultAccessibilityProperties.FORM_FIELD_TEXT = "tv"

static

Represents the role: Text.

Represents the role: Text. This can be passwords, text areas, etc.