bCompoundValue:Init()

Purpose

Creates an object of the class bCompoundValue.

Class

bCompoundValue

Type

Method

Syntax

bCompoundValue{

<uValue>,

[<oOrigin>],

[<oSize>],

[<iAlignment>],

[<oForeground>],

[<oBackground>],

[<oFont>],

[<iValueOptions>],

[<uTransformBlock>]

} Æ oCompoundValue

Arguments

The value that is to be drawn in the object.

Data Type:

Usual

The origin, at which the value is to be drawn. The zero of the origin is in the upper left corner. If another bCompoundValue is added by calling the method bCompoundValue:AddValue(), then the origin is relative to the origin of the first bCompoundValue.

Data Type:

Point

<oSize>

The width and height with which the value is to be drawn. If for the width and/or height the value -1 is specified, the appropriate value is dynamic and when drawing the value is defined by the maximum draw area. If the value were added another bCompoundValue by calling the method bCompoundValue:AddValue(), then the size is limited to the area of the above bCompoundValue.

Data Type:

Dimension

The alignment, with which the value is to be drawn. The following alignments are supported:

Constant	Description
BALIGN_AUTO	The default values for horizontal and vertical alignment are used.
BALIGN_LEFT	Left justified alignment.
BALIGN_RIGHT	Right justified alignment.
BALIGN_CENTER	Horizontal centered alignment.
BALIGN_TOP	Top justified alignment.
BALIGN_BOTTOM	Bottom justified alignment.
BALIGN_VCENTER	Vertical centered alignment.

Data Type:

Integer

The foreground color in which the value is to be drawn.

Data Type:

Color

The background color in which the value is to be drawn.

Data Type:

Brush

<oFont>

The font in which the value is to be drawn.

Data Type:

Font

Options with which the value can be formatted. The table below defines the supported options:

Option	Description
BVO_AUTO	No specific options are defined.
BVO_ASPECTRATIO	In combination with the option BVO_STRETCHIMAGE the aspect ratios of a bitmap become retain. This can mean that the bitmap is not adjusted to the whole size of the draw area.
BVO_END_ELLIPSIS	If the value cannot be displayed completely, then the value will be truncated and ellipsis are be added. The option can not be combined with: •BVO_RTF
BVO_LINEBREAK	If the value contains line break characters (CRLF), then the value is broken at these. The option can not be combined with: •BVO_RTF
BVO_RTF	The value is displayed as RTF text. The option can not be combined with: •BVO_END_ELLIPSIS •BVO_LINEBREAK
BVO_STRETCHIMAGE	If the value is a bitmap, then the size of the bitmap is adjusted to the size of the draw area.
BVO_WORDBREAK	If the value cannot be displayed completely in one line, then the value will be broken at words.

The options can be combined.

Data Type:

DWord

An expression as a string or a codeblock or bCodeblock object with which a value is to be transformed into another value. If a string is passed then this is converted automatically into object of the class _Codeblock. The conversion is made thereby with the following instruction:

&("{|Value| "+uTransformBlock+"}")

Data Type:

String | _Codeblock | Codeblock | bCodeblock

Return Value

oCompoundValue

The created object of the class bCompoundValue.

Data Type:

bCompoundValue

Description

bCompoundValue:Init() creates a new object of the class bCompoundValue and initializes it. By the method bCompoundValue:AddValue() subordinated single values can be added to the object.