Class PDFNet.FDFField
PDFNet.FDFField
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.FDFField(mp_leaf_node, mp_root_array)
FDFField is an interactive form field in an FDF document
|
| Method Attributes | Method Name and Description |
|---|---|
|
assign(right)
Copy Constructor
|
|
| <static> |
PDFNet.FDFField.create(field_dict, fdf_dict)
construct a FDF::FDFField from a SDF dictionary representing a terminal field node.
|
|
findAttribute(attrib)
The function returns the specified attribute.
|
|
|
getName()
|
|
|
getValue()
|
|
|
setValue(value)
Sets the value of the FDFField (the value of the field's /V key).
|
Class Detail
PDFNet.FDFField(mp_leaf_node, mp_root_array)
FDFField is an interactive form field in an FDF document
- Parameters:
- mp_leaf_node
- mp_root_array
Method Detail
assign(right)
Copy Constructor
- Parameters:
- {fdffield} right
- (generated documentation)
<static>
{fdffield}
PDFNet.FDFField.create(field_dict, fdf_dict)
construct a FDF::FDFField from a SDF dictionary representing a terminal field node.
- Parameters:
- {Obj} field_dict
- (generated documentation)
- {Obj} fdf_dict
- (generated documentation)
- Returns:
- {fdffield} A promise that resolves to an object of type: "fdffield" (generated documentation)
{Obj}
findAttribute(attrib)
The function returns the specified attribute.
- Parameters:
- {string} attrib
- name of the attribute to find
- Returns:
- {Obj} 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.
{string}
getName()
- Returns:
- {string} A promise that resolves to a string representing the fully qualified name of the field (e.g. "employee.name.first").
{string}
getPartialName()
- Returns:
- {string} 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).
{Obj}
getSDFObj()
- Returns:
- {Obj} A promise that resolves to the object to the underlying SDF/Cos object.
{Obj}
getValue()
- Returns:
- {Obj} 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.
setValue(value)
Sets the value of the FDFField (the value of the field's /V key).
- Parameters:
- {Obj} value
- 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.