pdftron::FDF::FDFField Class Reference

#include <FDFField.h>

List of all members.

Public Member Functions

 FDFField (SDF::Obj field_dict, SDF::Obj fdf_dict)
 Construct a FDF::FDFField from a SDF dictionary representing a terminal field node.
 FDFField (const FDFField &p)
FDFFieldoperator= (const FDFField &p)
SDF::Obj GetValue ()
void SetValue (SDF::Obj value)
 Sets the value of the FDFField (the value of the field's /V key).
UString GetName ()
UString GetPartialName ()
SDF::Obj GetSDFObj () const
SDF::Obj FindAttribute (const char *attrib) const
 The function returns the specified attribute.
 operator bool ()


Constructor & Destructor Documentation

pdftron::FDF::FDFField::FDFField ( SDF::Obj  field_dict,
SDF::Obj  fdf_dict 
)

Construct a FDF::FDFField from a SDF dictionary representing a terminal field node.

pdftron::FDF::FDFField::FDFField ( const FDFField p  ) 


Member Function Documentation

FDFField& pdftron::FDF::FDFField::operator= ( const FDFField p  ) 

SDF::Obj pdftron::FDF::FDFField::GetValue (  ) 

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.

void pdftron::FDF::FDFField::SetValue ( SDF::Obj  value  ) 

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

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.
Note:
in order to remove/erase the existing value use SetValue(SDF::Null)

UString pdftron::FDF::FDFField::GetName (  ) 

Returns:
a string representing the fully qualified name of the field (e.g. "employee.name.first").

UString pdftron::FDF::FDFField::GetPartialName (  ) 

Returns:
a string representing the partial name of the field (e.g. "first" when "employee.name.first" is fully qualified name).

SDF::Obj pdftron::FDF::FDFField::GetSDFObj (  )  const

Returns:
the object to the underlying SDF/Cos object.

SDF::Obj pdftron::FDF::FDFField::FindAttribute ( const char *  attrib  )  const

The function returns the specified attribute.

Returns:
return the attribute value if the given attribute name was found or a NULL object if the given attribute name was not found.

pdftron::FDF::FDFField::operator bool (  )  [inline]

Returns:
true if the object is not null, false otherwise.


© 2002-2010 PDFTron Systems Inc.