Class FDFField
Implements
Inherited Members
Namespace: pdftron.FDF
Assembly: PDFNet.dll
Syntax
public class FDFField : IDisposableConstructors
FDFField(Obj, Obj)
Construct a FDF::FDFField from a SDF dictionary representing a terminal field node.
Declaration
public FDFField(Obj field_dict, Obj fdf_dict)Parameters
| Type | Name | Description |
|---|---|---|
| Obj | field_dict | FDFField dictionary |
| Obj | fdf_dict | FDF dictionary |
Methods
Dispose()
Releases all resources used by the FDFField
Declaration
public override sealed void Dispose()Dispose(bool)
Declaration
[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | A_0 |
~FDFField()
Allows an FDFField to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
Declaration
protected ~FDFField()FindAttribute(string)
The function returns the specified attribute.
Declaration
public Obj FindAttribute(string attrib)Parameters
| Type | Name | Description |
|---|---|---|
| string | attrib | attribute name |
Returns
| Type | Description |
|---|---|
| Obj | return the attribute value if the given attribute name was found or a NULL object if the given attribute name was not found. |
GetName()
Get name of the FDFField
Declaration
public string GetName()Returns
| Type | Description |
|---|---|
| string | a string representing the fully qualified name of the field (e.g. "employee.name.first"). |
GetPartialName()
Get partial name of the FDFField
Declaration
public string GetPartialName()Returns
| Type | Description |
|---|---|
| string | a string representing the partial name of the field (e.g. "first" when "employee.name.first" is fully qualified name). |
GetSDFObj()
Get underlying SDF object
Declaration
public Obj GetSDFObj()Returns
| Type | Description |
|---|---|
| Obj | the object to the underlying SDF/Cos object. |
GetValue()
Get value of the FDFField
Declaration
public Obj GetValue()Returns
| Type | Description |
|---|---|
| Obj | the value of the Field (the value of its /V key) or NULL if the value is not specified. |
Remarks
The format of field’s value varies depending on the field type.
Set the value of the FDFField (the value of the field's /V key).
the value of the field (the value of its /V key) or NULL if the
value is not specified.
in order to remove/erase the existing value use SetValue(SDF::Null)
Set(FDFField)
Sets value to the given FDFField object
Declaration
public void Set(FDFField rf)Parameters
| Type | Name | Description |
|---|---|---|
| FDFField | rf | another FDFField object |
SetValue(Obj)
Set value of the FDFField
Declaration
public void SetValue(Obj value)Parameters
| Type | Name | Description |
|---|---|---|
| Obj | value | new value |
Remarks
The format of field’s value varies depending on the field type.
Set the value of the FDFField (the value of the field's /V key).
the value of the field (the value of its /V key) or NULL if the
value is not specified.
in order to remove/erase the existing value use SetValue(SDF::Null)
op_Assign(FDFField)
Assign value from another FDFField
Declaration
public FDFField op_Assign(FDFField r)Parameters
| Type | Name | Description |
|---|---|---|
| FDFField | r | another |
Returns
| Type | Description |
|---|---|
| FDFField | a |