Navigation:  Classes > bBrowser >

bBrowser:GetColorSpec()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Determines for the current record the foreground and background color from the defined color conditions.

Class

bBrowser

Type

Method

Syntax

<oBrowser>:GetColorSpec(

<iColumn>,

<nRowNo>,

<nRecNo>,

oForeground,

oBackground

) Æ aoColorSpec

Arguments

<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

 

<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

Return Value

aoColorSpecAn array with all 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

bBrowser:GetColorSpec() evaluates all defined color conditions for the current record. The first condition to return a result of TRUE determines which foreground and background color are returned.

 

If no color condition were found for the record or that none of the determined color conditions yield TRUE as a result, the foreground or background color are returned from the bBrowser:DataView object.

See Also

bBrowser:ColorCondition

bBrowser:DataView

bDataColumn:GetColorSpec()

 


Page url: http://www.YOURSERVER.com/index.html?bbrowser_getcolorspec.htm