GetNeedAppearances

Version history

This function was introduced in Quick PDF Library version 15.11.

Description

Returns the status of the document's NeedAppearances flag.

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.GetNeedAppearances: Integer;

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::GetNeedAppearances As Long

DLL

int DPLGetNeedAppearances(int InstanceID)

Return values

101	The document has a NeedAppearances flag and the value is set to True
102	The document has a NeedAppearances flag and the value is set to False
103	The document does not have a NeedAppearances flag, it will be interpreted as having a value of False in most PDF viewers