SetOutlineColor

Colour, Outlines

Description

Sets the colour of an outline item (bookmark). The values of the colour parameters range from 0 to 1, with 0 indicating 0% and 1 indicating 100% of the colour.

Syntax

Delphi

function TPDFlib.SetOutlineColor(OutlineID: Integer; Red, Green, Blue: Double): Integer;

ActiveX

Function PDFlib::SetOutlineColor(OutlineID As Long, Red As Double, Green As Double, Blue As Double) As Long

DLL

int DLSetOutlineColor(int InstanceID, int OutlineID, double Red, double Green, double Blue);

Parameters

OutlineIDThe ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID.
RedThe red component of the colour
GreenThe green component of the colour
BlueThe blue component of the colour

Return values

0The Outline ID provided was invalid
1The colour of the outline item was set successfully