PDFTron pdfnet-node

Class: FDFField

PDFNet. FDFField

new FDFField( [mp_leaf_node] [, mp_root_array])

FDFField is an interactive form field in an FDF document
Parameters:
Name Type Argument Description
mp_leaf_node PDFNet.Obj <optional>
mp_root_array PDFNet.Obj <optional>
Properties:
Name Type Description
mp_leaf_node PDFNet.Obj
mp_root_array PDFNet.Obj

Methods

<static> create( [field_dict] [, fdf_dict])

Construct a FDF::FDFField from a SDF dictionary representing a terminal field node.
Parameters:
Name Type Argument Description
field_dict PDFNet.Obj <optional>
fdf_dict PDFNet.Obj <optional>
Returns:
A promise that resolves to an object of type: "PDFNet.FDFField"
Type
Promise.<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
Promise.<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
Promise.<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
Promise.<string>

getSDFObj()

Returns:
A promise that resolves to the object to the underlying SDF/Cos object.
Type
Promise.<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
Promise.<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 Note: in order to remove/erase the existing value use SetValue(SDF::Null)
Returns:
Type
Promise.<void>