Purpose
Register a bBrowser as a client in the bBrowserCollection.
Class
Type
Method
Syntax
<oBrowserCollection>:RegisterClient(
<oClient>,
<iFlags>
) Æ lSuccess
Arguments
<oClient> | The bBrowser to be registered as a client of the bBrowserCollection. |
Data type: | bBrowser |
<iFlags> | The actions to be synchronized for the client. The table below defines the supported actions: |
Flag |
Synchronized Action |
BBCF_NONE |
Synchronize no actions. |
BBCF_ALL |
Synchronize all actions. |
BBCF_SYNCRONIZE_CURRENT_COLUMN |
Moving the table cursor within a record. |
BBCF_SYNCRONIZE_SELECTION |
Changing the selection. |
BBCF_SYNCRONIZE_COLUMN_MOVE |
Moving of columns with the mouse. |
BBCF_SYNCRONIZE_COLUMN_RESIZE |
Resizing the column width with the mouse. |
BBCF_SYNCRONIZE_ROW_RESIZE |
Resizing the row height with the mouse. |
BBCF_SYNCRONIZE_CAPTION_CLICK |
Simple mouse clicks on the column captions. |
BBCF_SYNCRONIZE_CAPTION_DOUBLECLICK |
Double mouse clicks on the column captions. |
BBCF_SYNCRONIZE_CELL_CLICK |
Simple mouse clicks on the data cells. |
BBCF_SYNCRONIZE_CELL_DOUBLECLICK |
Double mouse clicks on the data cells. |
BBCF_SYNCRONIZE_FOOTER_CLICK |
Simple mouse clicks on the column footers. |
BBCF_SYNCRONIZE_FOOTER_DOUBLECLICK |
Double mouse clicks on the column footers. |
BBCF_SYNCRONIZE_SELECTOR_CLICK |
Simple mouse clicks on the selector column. |
BBCF_SYNCRONIZE_SELECTOR_DOUBLECLICK |
Double mouse clicks on the selector column. |
BBCF_SYNCRONIZE_CURRENT_RECORD |
Moving the table cursor on other records. |
BBCF_SYNCRONIZE_HORIZONTAL_SCROLL |
Horizontal scrolling. |
BBCF_SYNCRONIZE_VERTICAL_SCROLL |
Vertical scrolling. |
BBCF_SYNCRONIZE_HSCROLLBAR_VISIBILITY |
Visibility of the horizontal scrollbar. |
BBCF_SYNCRONIZE_VSCROLLBAR_VISIBILITY |
Visibility of the vertical scrollbar. |
BBCF_SYNCRONIZE_EDIT_CELL |
Starting cell editing.
Important note! |
Several flags can be combined.
Data type: | DWord |
Return Value
lSuccess | A logical value that indicates whether the client could be registered. |
TRUE | The client was registered. |
FALSE | The client could not be registered. |
Data type: | Logic |
Description
A bBrowser that shall be synchronized by the bBrowserCollection must be registered as a client. For every client different flags can be specified for the synchronization. It is therefore possible to synchronize several bBrowsers of a bBrowserCollection differently. The flags can be determined and changed at a later time with the method bBrowserCollection:ClientInfo().
After a successful registration the new client is synchronized automatically with the first client of the bBrowserCollection. To do this, the method bBrowserCollection:SynchronizeClient() is invoked.
With the method bBrowserCollection:UnregisterClient() a registered client can be unregistered again.
See Also
bBrowserCollection:ClientInfo()
bBrowserCollection:SynchronizeClient()
bBrowserCollection:UnregisterClient()
Page url: http://www.YOURSERVER.com/index.html?bbrowsercollection_regclient.htm