SetImageOptional

Image handling, Content Streams and Optional Content Groups

Description

Links the selected image to an optional-content group or membership dictionary

When the selected image owns /Alternates, its visibility controls whether the built-in renderer uses the base image or examines optional-content alternate entries

Syntax

Delphi

Function TPDFlib.SetImageOptional(OptionalContentGroupID: Integer): Integer;

ActiveX

Function PDFlib::SetImageOptional(OptionalContentGroupID As Long) As Long

DLL

int DLSetImageOptional(int InstanceID, int OptionalContentGroupID);

Parameters

OptionalContentGroupID	An optional-content group handle or a membership handle returned by NewOptionalContentMembership

Return values

0	No image was selected or the optional-content handle was invalid
1	The selected image was linked successfully