Purpose
Creates an object of the class bCompoundValue.
Class
Type
Method
Syntax
bCompoundValue{
<uValue>,
[<oOrigin>],
[<oSize>],
[<iAlignment>],
[<oForeground>],
[<oBackground>],
[<oFont>],
[<iValueOptions>]
} Æ oCompoundValue
Arguments
<uValue> | The value that is to be drawn in the object. |
Data type: | Usual |
<oOrigin> | 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 |
<iAlignment> | 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 |
<oForeground> | The foreground color in which the value is to be drawn. |
Data type: | Color |
<oBackground> | 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 |
<iValueOptions> | 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_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_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 |
The value is displayed as RTF text.
The option can not be combined with:
|
||||
BVO_WORDBREAK |
If the value cannot be displayed completely, then the value will be broken at words. |
The options can be combined.
Data type: | DWord |
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.
See Also
Page url: http://www.YOURSERVER.com/index.html?bcompoundvalue_init.htm