Click or drag to resize

PdfField Class

Represents a base class for all fields in an interactive form.
Inheritance Hierarchy

Namespace: SautinSoft.Pdf.Forms
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.11.26
Syntax
public abstract class PdfField : PdfAnnotation

The PdfField type exposes the following members.

Properties
 NameDescription
Public propertyActions(Optional; PDF 1.1) An action that shall be performed when the field's annotation is activated (see 12.6, "Actions").
Public propertyAnnotationType Gets the Widget value.
(Overrides PdfAnnotationAnnotationType)
Public propertyAppearance Gets the appearance settings for this PdfField.
Public propertyDefaultValue(Optional; inheritable) The default value to which the field reverts when a reset-form action is executed. The format of this value is the same as that of Value.
Public propertyFieldType Gets the type of this field.
Public propertyHidden

(PDF 1.2) If set, do not display the annotation on the screen or allow it to interact with the user.

The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.

Public propertyName Gets the (fully qualified) field name.
Public propertyPrint

(PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen.

Note  Note
This can be useful for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.
Public propertyReadOnly If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.
Public propertyTooltip(Optional; PDF 1.3) An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in 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 (see 14.9.3, "Alternate Descriptions").
Public propertyValue(Optional; inheritable) The field’s value, whose format varies depending on the field type. See the descriptions of individual field types for further information.
Top
Methods
 NameDescription
Public methodToString Returns a String that represents this PdfField instance.
(Overrides ObjectToString)
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also