Purpose
Determines the first color condition with the value TRUE and returns in addition the foreground and background color.
Class
Type
Method
Syntax
<oColorConditionList>:GetColorSpec(
<oForeground>,
<oBackground>,
<iColumn>,
<nRowNo>,
<nRecNo>
) Æ aoColorSpec
Arguments
<oForeground> | The default foreground color that is to be used, if no color condition were found or if in the determined color condition no foreground color is defined. |
Data Type: | Color |
<oBackground> | The default background color that is to be used, if no color condition were found or if in the determined color condition no background color is defined. |
Data Type: | Brush |
<iColumn> | The column number of the cell, which is passed as argument to the conditions. |
Data Type: | Integer |
<nRowNo> | The row number of the cell, which is passed as argument to the conditions. |
Data Type: | Integer | Float | Real8 |
<nRecNo> | The record number of the cell, which is passed as argument to the conditions. |
Data Type: | Integer | Float | Real8 |
Return Value
aoColorSpec | An array with the determined foreground and background colors for normal and selected display. The array consists of 6 elements. The individual elements can be accessed by predefined constants (see table). |
Constant |
Contents |
Data type |
BCS_FOREGROUND |
Foreground color |
Color |
BCS_BACKGROUND |
Background color |
Brush |
BCS_SELECTEDFOREGROUND |
Foreground color for selected cells and rows |
Color |
BCS_SELECTEDBACKGROUND |
Background color for selected cells and rows |
Brush |
BCS_INACTIVESELECTEDFOREGROUND |
Foreground color for inactive selected cells and rows. |
Color |
BCS_INACTIVESELECTEDBACKGROUND |
Background color for inactive selected cells and rows. |
Brush |
Data Type: | Array |
Description
bColorConditionList:GetColorSpec() evaluates in sequence the color condition in the list and returns on the color condition whose result is as first TRUE the foreground and background colors.
If the list does not contain color conditions or no color condition returns the value TRUE, the specified colors are returned.
Page url: http://www.YOURSERVER.com/index.html?bcolorconditionlist_getcolorsp.htm