ScreenSetBackgroundColor Method |
Sets the background color of the Screen.
(Optional)
Namespace:
pdftron.PDF.Annots
Assembly:
pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax public void SetBackgroundColor(
ColorPt c,
int CompNum
)
Public Sub SetBackgroundColor (
c As ColorPt,
CompNum As Integer
)
public:
virtual void SetBackgroundColor(
[InAttribute] ColorPt^ c,
[InAttribute] int CompNum
) sealed
function SetBackgroundColor(c, CompNum);
Parameters
- c
- Type: pdftron.PDFColorPt
A ColorPt object that denotes the color of the wdget background.
- CompNum
- Type: SystemInt32
An int whose value implies the color space used for the parameter c.
Remarks it is necessary to make sure the consistancy between the ColorPt type
and the ColorSpace::Type value. e_device_gray corresponds to an array of two numbers;
e_device_rgb corresponds to an array of 3 numbers, e_device_cmyk corresponds to an array of
4 numnbers, while e_null correspons to an arry of 0 number. Entries out of the specified
color space array length will be desgarded. However, missing entries for a specified color space
will throw exception either when setting the color or when later retrieving color(colorspace)
information.
This property is part of the Screen appearance characteristics dictionary, this dictionary
that shall be used in constructing a dynamic appearance stream specifying the annotation’s visual
presentation on the page.
See Also