DynaPDF Manual - Page 324

Previous Page 323   Index   Next Page 325

Function Reference
Page 324 of 839
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
DeleteField
Syntax:
SI32 pdfDeleteField(
const PPDF* IPDF, // Instance pointer
UI32 AField)
// Field handle
This function deletes an interactive form field. The parameter AField 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 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 DeleteFieldEx() for further
information.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
DeleteFieldEx
Syntax:
SI32 pdfDeleteFieldEx(
const PPDF* IPDF, // Instance pointer
const char* Name) // Full qualified field name
This function deletes an interactive form field by using its full qualified name, that is the name of
any parent group field separated by a period (.) plus the field name.
Remarks:
Check boxes of a radio button have no name. It is not possible to delete such a check box by using
this function, use DeleteField() instead. However, the entire radio button can be deleted with this
function.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
 

Previous topic: DeleteBookmark, DeleteDPartNode, DeleteEmbeddedFile

Next topic: DeleteJavaScripts, DeleteOCGFromAppEvent, DeleteNamedDest