Purpose
Determines the background color that is used when drawing a particular column.
Class
Type
Method
Syntax
<oBrowser>:GetColumnBackground(
<symStyle>,
<oColumn>
) Æ oBackground
Arguments
<symStyle> | A value that indicates whether the background color is to be determined for the column caption, the column values or for the column footer. The following values are supported: |
Value |
Description |
#Caption |
The background color is determined for the column caption. |
#Data |
The background color is determined for the column values. |
#Footer |
The background color is determined for the column footer. |
Data Type: | Symbol |
<oColumn> | The column for which the background color is to be determined. |
Data Type: | bDataColumn |
Return Value
oBackground | The determined background color. |
Data Type: | Brush |
Description
If the background color is determined for the column caption,
1.it is examined whether in the column a bBrowserColumn:CaptionView object is defined and whether in this a background color (see also bBrowserColumn:CaptionView:Background) is set unequal to NULL_OBJECT.
Ü If it is, this background color is returned.
2.it is examined whether in the browser a bBrowser:CaptionView object is defined.
Ü If it is, the background color (see also bBrowser:CaptionView:Background) from this object is returned.
3.Ü the value NULL_OBJECT is returned.
If the background color is determined for the column values,
1.it is examined whether in the column a bBrowserColumn:DataView object is defined and whether in this a background color (see also bBrowserColumn:DataView:Background) is set unequal to NULL_OBJECT.
Ü If it is, this background color is returned.
2.it is checked whether in the browser a bBrowser:DataView object is defined.
Ü If it is, the background color (see also bBrowser:DataView:Background) from this object is returned.
3.Ü the value NULL_OBJECT is returned.
If the background color is determined for the column footer,
1.it is examined whether in the column a bBrowserColumn:FooterView object is defined and whether in this a background color (see also bBrowserColumn:FooterView:Background) is set unequal to NULL_OBJECT.
Ü If it is, this background color is returned.
2.it is examined whether in the browser a bBrowser:FooterView object is defined.
Ü If it is, the background color (see also bBrowser:FooterView:Background) from this object is returned.
3.Ü the value NULL_OBJECT is returned.
See Also
bBrowser:GetColumnAlphaBlendRatio()
bBrowser:GetColumnForeground()
Page url: http://www.YOURSERVER.com/index.html?bbrowser_getcolumnbackground.htm