FlattenFormField

Form fields, Page layout

Description

Use this function to draw the visual appearance onto the page it is associated with. The form field will then be removed from the document and only it's appearance will remain - it will no longer be an interactive field.

If the field is flattened successfully the field index of subsequent form fields will be decreased by 1.

From version 9.11 this function no longer updates the form field's appearance stream before flattening. To update the appearance stream before flattening, use the UpdateAndFlattenFormField function or call UpdateAppearanceStream followed by a call to this function.

Syntax

Delphi

function TDebenuPDFLibrary1811.FlattenFormField(Index: Integer): Integer;

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::FlattenFormField(Index As Long) As Long

DLL

int DPLFlattenFormField(int InstanceID, int Index)

Parameters

Index

The index of the form field to work with. The first form field has an index of 1.

Return values

0	The form field could not be found or it was not possible to flatten the form field
1	The form field was flattened successfully