GetFormFieldBackgroundColor

Form fields, Color

Description

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

0 = No color 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

IndexThe index of the form field to examine
ColorComponentFor DeviceGray (color type = 1) 1 = Gray level For DeviceRGB (color type = 3) 1 = Red 2 = Green 3 = Blue For DeviceCMYK (color type = 4) 1 = Cyan 2 = Magenta 3 = Yellow 4 = Black