UpdateAppearanceStream

Form fields

Description

Generates an appearance stream for the form field. Appearance streams can be generated for text, pushbutton, choice, checkbox and radio-button form fields

Syntax

Delphi

Function TPDFlib.UpdateAppearanceStream(Index: Integer): Integer;

ActiveX

Function PDFlib::UpdateAppearanceStream(Index As Long) As Long

DLL

int DLUpdateAppearanceStream(int InstanceID, int Index);

Parameters

IndexThe index of the form field to work with; the first form field has an index of 1

Return values

0The form field could not be found or an appearance stream could not be created for the specified field
1The appearance stream for the specified form field was created successfully

Remarks

A successful call removes the Widget from the current-session appearance dirty set. If generation fails, the Widget remains dirty and

NeedAppearances remains true so a later batch refresh can retry it

See also

GetDirtyFormAppearanceCount, RegenerateDirtyFormAppearances, RegenerateFormAppearances