Purpose
Determines column formatting options to be used for drawing.
Class
Type
Method
Syntax
<oBrowser>:GetColumnOptions(
<symStyle>,
<oColumn>
) Æ iOptions
Arguments
<symStyle> | A value that indicates whether the formatting options are to be determined for the column caption, the column values or for the column footer. The following values are supported: |
Value |
Description |
#Caption |
The formatting options are determined for the column caption. |
#Data |
The formatting options are determined for the column values. |
#Footer |
The formatting options are determined for the column footer. |
Data type: | Symbol |
<oColumn> | The column for which the formatting options are to be determined. |
Data type: | bDataColumn |
Return Value
iOptions | The determined formatting options. A combination from the following values can be returned: |
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. |
Data type: | DWord |
Description
If the formatting options are determined for the column caption,
1. | it examines if this column has a bBrowserColumn:CaptionView object defined for it and whether the formatting options (see also bViewStyle:Options) in this object IS NOT set to BVO_AUTO. Ü If so, this formatting options are returned. |
2. | it examines whether in the browser a bBrowser:CaptionView object is defined. Ü If it is, the formatting options (see also bViewStyle:Options) from this object are returned. |
3. | Ü the formatting option BVO_AUTO is returned. |
If the formatting options are determined for the column values,
1. | it examines if this column has a bBrowserColumn:DataView object defined for it and whether the formatting options (see also bViewStyle:Options) in this object IS NOT set to BVO_AUTO. Ü If so, this formatting options are returned. |
2. | it examines if in the browser a bBrowser:DataView object is defined. Ü If it is, the formatting options (see also bViewStyle:Options) from this object are returned. |
3. | Ü the formatting option BVO_AUTO is returned. |
If the formatting options are determined for the column footer,
1. | it examines if in the column a bBrowserColumn:FooterView object is defined for it and whether formatting options (see also bViewStyle:Options) in this object IS NOT set to BVO_AUTO. Ü If it is, this formatting options are returned. |
2. | it examines if in the browser a bBrowser:FooterView is a defined object. Ü If it is, the formatting options (see also bViewStyle:Options) from this object are returned. |
3. | Ü the formatting option BVO_AUTO is returned. |
See Also
Page url: http://www.YOURSERVER.com/index.html?bbrowser_getcolumnoptions.htm