Class FormField

Represents an interactive form field that can collect user input within a PDF document.

Inheritance
System.Object
FormField
FormField<T>
RadioButtonField
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Fixed.Model.InteractiveForms
Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public abstract class FormField : IInstanceIdOwner, IStructuralElement

Properties

Actions

Gets the collection of actions triggered by form field events such as value changes or mouse interactions.

Declaration
public FormFieldActionCollection Actions { get; }
Property Value
FormFieldActionCollection

FieldType

Gets the specific type of this form field (text, button, choice, etc.).

Declaration
public abstract FormFieldType FieldType { get; }
Property Value
FormFieldType

IsReadOnly

Gets or sets a value indicating whether this field should not accept user input or changes.

Declaration
public bool IsReadOnly { get; set; }
Property Value
System.Boolean

IsRequired

Gets or sets a value indicating whether this field must contain a value when the form is submitted.

Declaration
public bool IsRequired { get; set; }
Property Value
System.Boolean

MappingName

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

Declaration
public string MappingName { get; set; }
Property Value
System.String

Name

Gets or sets the unique identifier name for this form field.

Declaration
public string Name { get; set; }
Property Value
System.String

The field name used to identify this form field uniquely within the document.
Exceptions
System.ArgumentNullException

Name cannot be empty.

ShouldBeSkipped

Gets or sets a value indicating whether this field should be excluded from form submission.

Declaration
public bool ShouldBeSkipped { get; set; }
Property Value
System.Boolean

StructureTag

Gets the StructureTag associated with this element.

Declaration
public StructureElement StructureTag { get; set; }
Property Value
StructureElement

Implements

TextProperties

Gets or sets the text formatting properties used by PDF viewers to render the field's appearance dynamically.

Declaration
public VariableTextProperties TextProperties { get; set; }
Property Value
VariableTextProperties

UserInterfaceName

Gets or sets an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface. For instance this may be used for error or status messages referring to the field. This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.

Declaration
public string UserInterfaceName { get; set; }
Property Value
System.String

Widgets

Gets a collection of all visual widget representations of this form field that appear on document pages.

Declaration
public IEnumerable<Widget> Widgets { get; }
Property Value
System.Collections.Generic.IEnumerable<Widget>

An enumerable collection of widgets associated with this form field.

Methods

Equals(Object)

Returns a value indicating whether this instance is equal to a specified object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The object to compare with the current form field.
Returns
System.Boolean

true if the specified object is equal to the current form field; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for the current form field based on its key properties.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code value for the current form field instance.
Overrides
System.Object.GetHashCode()