Navigation:  Classes > bBrowser >

bBrowser:PropertyPut()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Sets a property value.

Class

bBrowser

Type

Method

Syntax

<oBrowser>:PropertyPut(

<symProperty>,

<uValue>

) Æ lSuccess

Arguments

<symProperty>The name of the property for which the value is to be set. The following properties are supported as default:

 

Property

Description

#BitmapStretch

Defines the size to be adapted to the drawing area when drawing a bitmap.

#BitmapTransparentColor

Defines the transparent background color. This is needed so that a bitmap can be drawn transparent. The color is an RGB-Value of the data type DWord.

#CellGroupMoveDisableIcon

Defines the icon that is shown when moving a cell group on an invalid position.

#CellGroupMoveEnableIcon

Defines the icon that is shown when moving a cell group on a valid position.

#CaptionPointer

Defines the mouse cursor that is shown when the mouse is over a column caption.

 

See also property:

#CaptionTouchPointer

#ColumnResizePointer

#CaptionTouchPointer

Defines the mouse cursor that is shown when the mouse is over a column caption and the column can move with the mouse.

 

See also property:

#CaptionPointer

#ColumnResizePointer

#ColumnClass

Defines the name of the VO Class, that bBrowser uses for creating data columns.

#ColumnMovePointer

The property is not supported any more. Use the following properties instead:

#ColumnMoveLeftPointer

#ColumnMoveNoPointer

#ColumnMoveRightPointer

 

Defines the mouse cursor that is shown when a column is moved with the mouse.

#ColumnMoveLeftPointer

Define the mouse cursor that is shown when a column is moved with the mouse and can be inserted on the left of the column.

#ColumnMoveNoPointer

Define the mouse cursor that is shown when a column is moved with the mouse and cannot be inserted at the current column.

#ColumnMoveRightPointer

Define the mouse cursor that is shown when a column is moved with the mouse and can be inserted on the right of the column.

#ColumnResizePointer

Defines the mouse cursor that is shown when the width of a column can changed with the mouse.

 

See also property:

#CaptionPointer

#CaptionTouchPointer

#ColumnWidthMax

Defines a maximum width of the column in pixels.

 

The maximum width is considered in the following cases:

Within the method bDataColumn:CalculateWidth(), in order to calculate the width of the column.

When changing the column width with the mouse.

If the column is defined with bBrowser:AutoWidthColumn.

 

Note:
The value of this property is considered only if the column does not have its own maximum width defined (see also bDataColumn:WidthMax).

#ColumnWidthMin

Defines a minimum width of the column in pixels.

 

The minimum width is considered in the following cases:

Within the method bDataColumn:CalculateWidth(), in order to calculate the width of the column.

When changing the column width with the mouse.

If the column is defined as bBrowser:AutoWidthColumn.

 

Note:
The value of this property is considered only if the column does not have its own minimum width defined (see also bDataColumn:WidthMin).

#ComboListHeightMax

Defines the maximum height of the list of a combobox during a data cell input.

#ContextMenuMode

Defines whether locally defined context menus shall be shown or also those of the owner.

 

Note:
The property is supported only for Visual Objects 2.7 or later. For earlier versions this property is ignored.

#DataPointer

Defines the mouse cursor that is shown when the mouse is over a data cell.

#DefaultButtonManage

Defines whether the default button is managed.

#DragMultiplePointer

Defines the mouse cursor that is shown when several items are dragged.

#DragSinglePointer

Defines the mouse cursor that is shown when a single item is dragged.

#DragStartDelay

Defines an interval (milliseconds) after whose expiry a drag & drop process is started.

#DropNotAllowedPointer

Defines the mouse cursor that is shown during a drag & drop process when dropping is not allowed.

#FooterPointer

Defines the mouse cursor that is shown when the mouse is over a footer cell.

#InfoInEntireArea

Defines the area within which an info value is drawn.

#LogicValueIdentifier

Defines an array of values which are identified as logical values. Every array item consists of a sub array with 2 items. The first item contains the value which shall be identified as logical value. The second item contains the corresponding logical value TRUE or FALSE.

 

Note:
In conjunction with the access bDataColumn:ViewValueAs and the value #CheckBox or #Check this property can be used to display arbitrary values as logical values in a CheckBox.

#MouseWheelMode

Defines whether the mouse is scrolled or skipped when the mouse wheel is turned.

#MouseWheelUnitSize

Defines the number of lines scrolled when turning the mouse wheel.

#RecordGroupCaptionBackground

Defines the background color that is used for drawing the record group column within the caption area.

 

Notes:
If the property is not defined then the background color is used from the access bBrowser:RecordGroupView:Background.

#RecordGroupCaptionGrid

Defines the grid that is used for drawing the record group column within the caption area.

 

Notes:
If the property is not defined then the grid is used from the access bBrowser:RecordGroupView:Grid.

#RMASelectionMode

Defines for the bBrowser:RowMode #Absolute the supported selection mode (single or block selection).

#RowResizePointer

Defines the mouse cursor that is shown when the height of a row with the mouse is changed.

#RTFInterfaceClass

Defines the name of the VO Class, that the bBrowser uses for drawing RTF text.

#ScrollHUnitPixel

Defines the number of pixels if the columns are scrolled horizontal 1 unit.

#ScrollPointer

Defines the mouse cursor that is shown when it is scrolled.

#ScrollThumbDragRefresh

Defines whether the records are refreshed constantly or only at the end of scrolling.

#SelectorCaptionBackground

Defines the background color that is used for drawing the selector within the caption area.

 

Notes:
If the property is not defined or no brush object is defined for the property then the background color is used from the access bBrowser:SelectorView:Background.

#SelectorCaptionGrid

Defines the grid that is used for drawing the selector within the caption area.

 

Notes:
If the property is not defined then the grid is used from the access bBrowser:SelectorView:Grid.

#SelectorPointer

Defines the mouse cursor that is shown when the mouse is over a selector cell.

#SortMarkerHeight

Defines the height of a sort marker in pixel.

#SQLRequeryMethod

Define the name of the method that is invoked in the method bBrowser:AutoRefresh() to determined the visible data from the linked data server again.

#ValueViewList

List of bDataColumn:ViewValueAs that are shown in all rows. All others are shown only in the current row.

#ViewLogicValues

Defines which text is used to display the logical values of TRUE and FALSE.

 

In addition to these properties any other property can also be defined.

Data Type:Symbol

 

<uValue>The value that is to be put to the property:

 

Property

Value

#BitmapStretch

A logical value.

 

TRUE:The size of the bitmap is adapted.
FALSE:The size of the bitmap is not adapted. This is the default.

#BitmapTransparentColor

As default the RGB-Value for the color white is used. With the function bRGB(<oColor >) an object of the class Color can be converted into an RGB-Value.

 

Data Type: DWord

#CellGroupMoveDisableIcon

As default the following icon is used:

CellGroupMove_Disabled

 

Data Type: Icon

#CellGroupMoveEnableIcon

As default the following icon is used:

CellGroupMove_Enabled

 

Data Type: Icon

#CaptionPointer

As default the following mouse cursor is used:

CURARROW

 

Data Type: Pointer

#CaptionTouchPointer

As default the following mouse cursor is used:

CURARROW

 

Data Type: Pointer

#ColumnClass

As default the value #bDataColumn is used.

 

Data Type: Symbol

#ColumnMoveLeftPointer

As default the following mouse cursor is used:

CurColML

 

Data Type: Pointer

#ColumnMoveNoPointer

As default the following mouse cursor is used:

CurColMN

 

Data Type: Pointer

#ColumnMoveRightPointer

As default the following mouse cursor is used:

CurColMR

 

Data Type: Pointer

#ColumnResizePointer

As default the following mouse cursor is used:

CurColRz

 

Data Type: Pointer

#ColumnWidthMax

As default 0 is uses. This means that the column width is not limited.

 

Data Type: DWord

#ColumnWidthMin

As default 0 is uses. This means that the column width is not limited.

 

Data Type: DWord

#ComboListHeightMax

As default 200 is uses. This means that the list is at most 200 pixels high.

 

Data Type: DWord

#ContextMenuMode

The following values are supported:

BBP_CMM_ALL
The context menus of the bBrowser and optional of the owner are shown.
 
Note:
If the bBrowser does not have a context menu but its owner does, then the owner's context menu is shown.

BBP_CMM_CONTROL
Only the context menus of the bBrowser are shown.
 
Note:
If the bBrowser doesn't have a context menu, then no context menu is shown.

 

The default value is BBP_CMM_ALL.

 

Data Type: DWord

#DataPointer

As default the following mouse cursor is used:

CurArrow

 

Data Type: Pointer

#DefaultButtonManage

A logical value.

 

TRUE:The default button is managed. This is the default.
FALSE:The default button is not managed.

#DragMultiplePointer

As default the following mouse cursor is used:

CurDragMultiple

 

Data Type: Pointer

#DragSinglePointer

As default the following mouse cursor is used:

CurDragSingle

 

Data Type: Pointer

#DragStartDelay

As default the value 100 is uses. This means that a drag & drop process starts only after 100 milliseconds.

 

Data Type: DWord

#DropNotAllowedPointer

As default the following mouse cursor is used:

CurDropNotAllowed

 

Data Type: Pointer

#FooterPointer

As default the following mouse cursor is used:

CurArrow

 

Data Type: Pointer

#InfoInEntireArea

A logical value.

 

TRUE:The info value is drawn in the entire data area.
FALSE:The info value is drawn only in the data area in which opened columns are. This is the default.

#LogicValueIdentifier

An array with an arbitrary number of items. Every array item must contain a sub array with 2 items. The first item contains the value which shall be identified as the logical value. The second item contains the corresponding logical value TRUE or FALSE.

 

Samples:

The string values "Y" and "N" shall be identified as TRUE and FALSE.

{{"Y", TRUE}, {"N", FALSE}}

The string values "T" and "F" shall be identified as TRUE and FALSE.

{{"T", TRUE}, {"F", FALSE}}

The numeric values 1 and 0 shall be identified as TRUE and FALSE.

{{1, TRUE}, {0, FALSE}}

The values "Y" and 1 shall be identified as TRUE and the values "N" and 0 shall be identified as FALSE.

{;

  {"Y", TRUE},  {1, TRUE},;

  {"N", FALSE}, {0, FALSE};

}

#MouseWheelMode

A symbol value:

 

#Scroll:With turning the mouse wheel is scrolled. This is the default.
#Skip:With turning the mouse wheel is skipped.

#MouseWheelUnitSize

A numeric value that indicates how many rows are to be scrolled. Only values greater than 0 are supported. The default is 1.

#RecordGroupCaptionBackground

The property is not defined as default. This means that the background color is used from the access bBrowser:RecordGroupView:Background.

 

Data Type: Brush

#RecordGroupCaptionGrid

The property is not defined as default. This means that the grid is used from the access bBrowser:RecordGroupView:Grid.

 

Data Type: bGrid

#RMASelectionMode

The following values are supported:

#Singe
When marking cells and rows only one record can be selected (single selection).
 

#Block
When marking cells and rows blocks can be selected (block selection).
 
Notes
This mode can have negative effect on the runtime behavior of the bBrowser. It relies heavily on data access in the data server and should be used only for data servers with minimal records (ie. < 500). If a selective relation is active in the data server, then the result set of this relation should not contain any more than 200 records. The exact number of records is dependent on the operating system, the RDD in use, the PC and the network and can not be precisely defined.

 

As default the value #Single is used.

 

Data Type: Symbol

#RowResizePointer

As default the following mouse cursor is used:

CurRowRz

 

Data Type: Pointer

#RTFInterfaceClass

As default the value #bRTFDocument is used.

 

Data Type: Symbol

#ScrollHUnitPixel

As default the value 10 is used.

 

Data Type: DWord

#ScrollPointer

As default the following mouse cursor is used:

CurScrol

 

Data Type: Pointer

#ScrollThumbDragRefresh

A logical value.

 

TRUE:The records are constantly refreshed. This is the default.
FALSE:The records are refreshed only at the end of scrolling.

#SelectorCaptionBackground

The property is not defined as default. This means that the background color is used from the access bBrowser:SelectorView:Background.

 

Data Type: Brush

#SelectorCaptionGrid

The property is not defined as default. This means that the grid is used from the access bBrowser:SelectorView:Grid.

 

Data Type: bGrid

#SelectorPointer

As default the following mouse cursor is used:

CURARROW

 

Data Type: Pointer

#SortMarkerHeight

As default the value 5 is used.

 

Data Type: DWord

#SQLRequeryMethod

Name of the method. The method must be defined in the linked data server.

 

If no method name is defined, then the method name #Execute is used for the class SQLSelect and the method name #Requery is used for the classes ADORecordSet or ADOServer.

 

Data Type: Symbol

#ValueViewList

As default only check boxes in all rows are shown.

 

Data Type: Array

#ViewLogicValues

A 2 dimensional array with 2 items.

 

The first item defines the text for the logical value TRUE and second item the text for the logical value FALSE.

 

Syntax:

{{<cTrue>, TRUE}, {<cFalse>, FALSE}}

 

For <cTrue> and <cFalse> the appropriate text must be specified.

 

Example:

{{"Yes", TRUE}, {"No", FALSE}}

 

Data Type:Usual

Return Value

lSuccessA logical value that indicates whether the value was put to the property.
TRUEThe value was put.
FALSEThe value could not be put.
Data Type:Logic

Description

bBrowser:PropertyPut() examines whether a value already exists for the property. In this case the existing value is overwritten with the new value otherwise the property and the value is appended.

 

In addition to the default properties others can be defined.

See Also

bBrowser:PropertyDelete()

bBrowser:PropertyExist()

bBrowser:PropertyGet()

bBrowser:SetInfo()

bBrowser:ViewLogicAs

bBrowserColumn:PropertyPut()

bDataColumn:PropertyPut()

bRGB()

bSample - Edit

 


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