Class: FDFField

PDFNet. FDFField


new FDFField()

FDFField is an interactive form field in an FDF document

Methods


<static> create(field_dict, fdf_dict)

Parameters:
Name Type Description
field_dict PDFNet.Obj
fdf_dict PDFNet.Obj
Returns:

A promise that resolves to an object of type: "fdffield"

Type
PDFNet.FDFField

assign(right)

Copy Constructor

Parameters:
Name Type Description
right PDFNet.FDFField

findAttribute(attrib)

The function returns the specified attribute.

Parameters:
Name Type Description
attrib string

name of the attribute to find

Returns:

A promise that resolves to return the attribute value if the given attribute name was found or a NULL object if the given attribute name was not found.

Type
PDFNet.Obj

getName()

Returns:

A promise that resolves to a string representing the fully qualified name of the field (e.g. "employee.name.first").

Type
string

getPartialName()

Returns:

A promise that resolves to a string representing the partial name of the field (e.g. "first" when "employee.name.first" is fully qualified name).

Type
string

getSDFObj()

Returns:

A promise that resolves to the object to the underlying SDF/Cos object.

Type
PDFNet.Obj

getValue()

Returns:

A promise that resolves to the value of the Field (the value of its /V key) or NULL if the value is not specified. The format of field's value varies depending on the field type.

Type
PDFNet.Obj

setValue(value)

Sets the value of the FDFField (the value of the field's /V key).

Parameters:
Name Type Description
value PDFNet.Obj

the value to set the FDFField to

Returns:

the value of the field (the value of its /V key) or NULL if the value is not specified. The format of field's value varies depending on the field type.