GetFormFieldBackgroundColor

Form fields, Colour

Description

Returns the background colour of the specified field. The number of available values will depend on the colour type specified in the form field. The number of components available can be retrieved using theGetFormFieldBackgroundColorType function.

0 = No colour specified

1 = DeviceGray (1 component)

3 = DeviceRGB (3 components)

4 = CMYK (4 components

Syntax

Delphi

function TPDFlib.GetFormFieldBackgroundColor(Index, ColorComponent: Integer): Double;

ActiveX

Function PDFlib::GetFormFieldBackgroundColor(Index As Long, ColorComponent As Long) As Double

DLL

double DLGetFormFieldBackgroundColor(int InstanceID, int Index, int ColorComponent);

Parameters

Index	The index of the form field to examine
ColorComponent	For DeviceGray (colour type = 1) 1 = Grey level For DeviceRGB (colour type = 3) 1 = Red 2 = Green 3 = Blue For DeviceCMYK (colour type = 4) 1 = Cyan 2 = Magenta 3 = Yellow 4 = Black