Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
DynaPDF.DeleteField
This function deletes an interactive form field.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
DynaPDF | 5.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.DeleteField"; PDF; Field ) More
Parameters
Parameter | Description | Example |
---|---|---|
The PDF reference returned from DynaPDF.New. | ||
Field | A field handle. | $field |
Result
Returns OK or error.
Description
This function deletes an interactive form field.The parameter Field must be a valid field handle. If the field is a radio button or group field, the child fields used are also deleted. There is no need to delete each field separately.
A field is never physically deleted. All field handles are still valid after a field was deleted, but the "Used" flag of the field is set to false (see DynaPDF.GetField for further information). If a field contained an action that was not used by another object then the action is also deleted.
Fields can also be deleted by using its name instead of the handle. See DynaPDF.DeleteFieldEx for further information.
See also DeleteField function in DynaPDF manual.
See also
- DynaPDF.DeleteFieldEx
- DynaPDF.DeletePage
- DynaPDF.FlushPages
- DynaPDF.GetField
- DynaPDF.GetPageField
- DynaPDF.New
This function checks for a license.
Created 6th February 2015, last changed 6th February 2015