API for PDFNet SDK for Universal Windows Platform (UWP)
pdftron.PDF.Annots
Widget Class
Widget Methods
Close Method
Create Method
DeleteCustomData Method
Flatten Method
GetAction Method
GetAnnotType Method
GetAppearance Method
GetBackgroundColor Method
GetBackgroundColorCompNum Method
GetBorderColor Method
GetBorderColorCompNum Method
GetBorderStyle Method
GetColorAsCMYK Method
GetColorAsGray Method
GetColorAsRGB Method
GetColorCompNum Method
GetContents Method
GetCustomData Method
GetDate Method
GetField Method
GetFitFull Method
GetFlag Method
GetFont Method
GetFontSize Method
GetHIconLeftOver Method
GetHighlightingMode Method
GetIconCaptionRelation Method
GetMouseDownCaptionText Method
GetMouseDownIcon Method
GetOptionalContent Method
GetPage Method
GetRect Method
GetRolloverCaptionText Method
GetRolloverIcon Method
GetRotation Method
GetScaleCondition Method
GetScaleType Method
GetSDFObj Method
GetStaticCaptionText Method
GetStaticIcon Method
GetStructParent Method
GetTextColor Method
GetTextColorCompNum Method
GetTriggerAction Method
GetUniqueID Method
GetVIconLeftOver Method
IsMarkup Method
IsValid Method
RefreshAppearance Method
RemoveAppearance Method
Resize Method
SetAction Method
SetAppearance Method
SetBackgroundColor Method
SetBorderColor Method
SetBorderStyle Method
SetColor Method
SetContents Method
SetCustomData Method
SetDate Method
SetDateToNow Method
SetFitFull Method
SetFlag Method
SetFont Method
SetFontSize Method
SetHIconLeftOver Method
SetHighlightingMode Method
SetIconCaptionRelation Method
SetMouseDownCaptionText Method
SetMouseDownIcon Method
SetOptionalContent Method
SetPage Method
SetRect Method
SetRolloverCaptionText Method
SetRolloverIcon Method
SetRotation Method
SetScaleCondition Method
SetScaleType Method
SetStaticCaptionText Method
SetStaticIcon Method
SetStructParent Method
SetTextColor Method
SetUniqueID Method
SetVIconLeftOver Method
Click or drag to resize

WidgetSetBackgroundColor Method

Sets the background color of the Widget. (Optional)

Namespace:  pdftron.PDF.Annots
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
Copy
public void SetBackgroundColor(
	ColorPt c,
	int 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 Widget 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