Class

FormField

Collection of actions triggered by field events such as value changes or mouse interactions.

Declaration

public FormFieldActionCollection Actions { get; }

Property Value

Gets the field category used by viewers to render and process the field (text, button, choice, etc.).

Declaration

public abstract FormFieldType FieldType { get; }

Property Value

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

Declaration

public bool IsReadOnly { get; set; }

Property Value

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

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

Gets or sets the field's unique name used to identify it within the document and exported form data.

Declaration

public string Name { get; set; }

Property Value

Exceptions

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

Declaration

public bool ShouldBeSkipped { get; set; }

Property Value

Gets the StructureTag associated with this element.

Declaration

public StructureElement StructureTag { get; set; }

Property Value

Implements IStructuralElement.StructureTag

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

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

Collection of visual widget instances that render this field on document pages.

Declaration

public IEnumerable<Widget> Widgets { get; }

Property Value

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

Declaration

public override bool Equals(object obj)

Parameters

Returns

Overrides object.Equals(object)

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

Declaration

public override int GetHashCode()

Returns

Overrides object.GetHashCode()