SetNeedAppearances

Description

Sets the value of the NeedAppearances flag in the PDF document.

Most PDF viewers will create the appearance stream for all form fields when the document is opened if this flag is set to True.

Quick PDF Library will not create appearance streams for form fields when form field values are changed if the flag is set to True, as it is expected that the PDF viewer will create the appearance streams.

If the NeedAppearances flag is missing it will be interpreted as False by most PDF viewers according to the PDF specification.

Best practice is to set the NeedAppearances flag to False using the SetNeedAppearances function and generate an appearance stream for each form field so that the appearance of the PDF is the same in all PDF viewers.

Syntax

Delphi

function TDebenuPDFLibrary1811.SetNeedAppearances(NewValue: Integer): Integer;

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::SetNeedAppearances(
NewValue As Long) As Long

DLL

int DPLSetNeedAppearances(int InstanceID, int NewValue)

Parameters

NewValue

-1 = Remove the NeedAppearances flag
0 = Set NeedAppearances to False
1 = Set NeedAppearances to True

Return values

0	The document does not have any form fields
1	The NeedAppearances flag was set successfully