RemoveFormFieldGroup

Description

Removes the form field group (PDFFormFieldGroup object) with the specified index in a PDF document.

Applies to

PDFDocument object

Syntax

long RemoveFormFieldGroup(long index)
long RemoveFormFieldGroup(PDFFormFieldGroup formFieldGroup)

Argument

Description

index

The index of the PDFFormFieldGroup object.

formFieldGroup

The PDFFormFieldGroup object.


Return value

Long. Returns 1 if it succeeds and -1 if the function fails. For more errors, see the Error Codes.

Usage

Call the function to remove all the PDFFormFieldGroup objects that are included in the current PDF document.

Examples

This example removes the PDFFormFieldGroup object with the index 1 in the document lpdf_doc.

Long ll_return
//Remove the group with the index 1
ll_return = lpdf_doc.removeformfieldgroup(1)

This example removes the PDFFormFieldGroup object with the name "lpdf_group" in the document lpdf_doc.

Long ll_return
//Remove the group with the name "lpdf_group"
ll_return = lpdf_doc.removeformfieldgroup(lpdf_group)

See also

AddFormFieldGroup

GetFormFieldGroup

GetFormFieldGroupCount

RemoveAllFormFieldGroup