Class FormField

Represents a form field.

Inheritance
System.Object
FormField
FormField<T>
RadioButtonField
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
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

Properties

Actions

Gets the actions associated with the form field.

Declaration
public FormFieldActionCollection Actions { get; }
Property Value
FormFieldActionCollection

FieldType

Gets the field type.

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

IsReadOnly

Gets or sets boolean value indicating whether the field is readonly.

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

IsRequired

Gets or sets boolean value indicating whether the field must have value at the time it is exported by submitting the form.

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 name.

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

The name.
Exceptions
System.ArgumentException

Name cannot contain .(period).
System.ArgumentNullException

Name cannot be empty.

ShouldBeSkipped

Gets or sets boolean value indicating whether the field should be skipped when submitting the form.

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

TextProperties

Represents the text properties used by the PDF viewer in order to build the fields 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 the widgets.

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

Extension Methods