FormField
Base abstraction for fields that collect user input in a PDF, exposing common properties, actions, and access to visual widgets.
Definition
Namespace:Telerik.Windows.Documents.Fixed.Model.InteractiveForms
Assembly:Telerik.Windows.Documents.Fixed.dll
Syntax:
public abstract class FormField : IStructuralElementInheritance: objectFormField
Derived Classes:
Implements:
Methods
Returns a value indicating whether this instance is equal to a specified object.
Returns a hash code for the current form field based on its key properties.
public override int GetHashCode()A hash code value for the current form field instance.
Overrides:
Properties
Collection of actions triggered by field events such as value changes or mouse interactions.
public FormFieldActionCollection Actions { get; }Gets the field category used by viewers to render and process the field (text, button, choice, etc.).
public abstract FormFieldType FieldType { get; }Gets or sets a value indicating whether this field should not accept user input or changes.
public bool IsReadOnly { get; set; }Gets or sets a value indicating whether this field must contain a value when the form is submitted.
public bool IsRequired { get; set; }Gets or sets the mapping name to be used when exporting interactive form field data from the document.
public string MappingName { get; set; }Gets or sets the field's unique name used to identify it within the document and exported form data.
public string Name { get; set; }The field name used to identify this form field uniquely within the document.
Exceptions:Name cannot be empty.
Gets or sets a value indicating whether this field should be excluded from form submission.
public bool ShouldBeSkipped { get; set; }Gets the StructureTag associated with this element.
public StructureElement StructureTag { get; set; }Implements:
Gets or sets the text formatting properties used by PDF viewers to render the field's appearance dynamically.
public VariableTextProperties TextProperties { get; set; }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.
public string UserInterfaceName { get; set; }Collection of visual widget instances that render this field on document pages.
public IEnumerable<Widget> Widgets { get; }An enumerable collection of widgets associated with this form field.