TIB_SessionProps Class

TIB_SessionProps Object
Properties Methods Events

Declaration
TIB_SessionProps = class(TIB_Component)

Description
This class surfaces the properties and events of the default component session so that they can be modified at design time.

With this component it is possible to turn off the screen cursor handling and change the colors used in data aware controls when the ColorScheme property of a TIB_Dataset is true.

It is also possible to intercept all error codes from API calls and log them or even override them with another action. Perhaps a more user friendly error message could be presented.

If more than ONE of these instances exist at one time in an application they will compete for the same settings. In this case, the last one to touch the default session's properties or events will take effect and any other settings will be overwritten.

It can also cause some interesting anomolies that should be harmless during design-time if more than one project is open and they each have a TIB_SessionProps component in use. This is because there is only one default session for them to share during design-time. I have it saving the property values in the DFM independant of the settings stored in the default session so each project will stay isolated from one another as to what gets stored in the DFM.

Try to keep this component among the first in the component creation order.

Introduced Public Properties

AllowDefaultConnection This property determines whether or not IBO will permit the default connection for the session to be automatically assigned to a statement or dataset that did not have its IB_Connection property explicitly assigned.

AllowDefaultTransaction This property determines whether or not IBO will permit a default internal transaction to be automatically assigned to a statement or dataset that did not have its IB_Transaction property explicitly assigned.

BrowsingColor This is the color that will show when the control is attached to a dataset that is browsing a record.

BusyCursor Determines the cursor that will appear on the screen when a process is active and there is no Yield indication.

DeletingColor If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssDeleting state.

EditingColor If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssEditing state.

InsertingColor If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssInserting state.

InvalidColor When a control is not attached to a datasource/dataset this is the color that the control will show as.

OnError Global hook for the session to gain control over the error handling for all calls made to the API.

OnGetDataLinkColor Event to override default colorscheme assignments by datalinks.

PreparedColor When a control is not attached to a prepared dataset this is the color that the control will show as.

ReadOnlyColor If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into a state above dssBrowse state and the control is a ReadOnly control.

SearchingColor If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssSearching state.

SelectedColor The color used for rows in a grid that are selected via multi-select.

StoreActive This property determines whether or not the following properties are stored in the DFM of the forms and datamodules.

TimerInterval This property controls the frequency that the session generates events to the components (transactions only for now).

UseCursor Determines if the Screen.Cursor should be adjusted when a process becomes active.

YieldCursor Determines the cursor that will appear on the screen when a process is active and there is a Yield indication.

Introduced Public Methods

Create

Introduced Public Events

OnBeginBusy Event hook to give access to when the first process becomes active.

OnBeginYield Event hook to give access to when the first process becomes active that was initiated with Yield as true.

OnEndBusy Event hook to give access to when the last process is completed or aborted.

OnEndYield Event to give access to when the last process is completed or aborted that was initiated with Yied as true.

OnSessionTimer This provides a hook into the session timer that operated in the background.

AllowDefaultConnection	This property determines whether or not IBO will permit the default connection for the session to be automatically assigned to a statement or dataset that did not have its IB_Connection property explicitly assigned.
AllowDefaultTransaction	This property determines whether or not IBO will permit a default internal transaction to be automatically assigned to a statement or dataset that did not have its IB_Transaction property explicitly assigned.
BrowsingColor	This is the color that will show when the control is attached to a dataset that is browsing a record.
BusyCursor	Determines the cursor that will appear on the screen when a process is active and there is no Yield indication.
DeletingColor	If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssDeleting state.
EditingColor	If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssEditing state.
InsertingColor	If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssInserting state.
InvalidColor	When a control is not attached to a datasource/dataset this is the color that the control will show as.
OnError	Global hook for the session to gain control over the error handling for all calls made to the API.
OnGetDataLinkColor	Event to override default colorscheme assignments by datalinks.
PreparedColor	When a control is not attached to a prepared dataset this is the color that the control will show as.
ReadOnlyColor	If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into a state above dssBrowse state and the control is a ReadOnly control.
SearchingColor	If ColorScheme is set to true for any IB_Dataset component then this color will be used by all data aware controls that reference this dataset when the dataset goes into dssSearching state.
SelectedColor	The color used for rows in a grid that are selected via multi-select.
StoreActive	This property determines whether or not the following properties are stored in the DFM of the forms and datamodules.
TimerInterval	This property controls the frequency that the session generates events to the components (transactions only for now).
UseCursor	Determines if the Screen.Cursor should be adjusted when a process becomes active.
YieldCursor	Determines the cursor that will appear on the screen when a process is active and there is a Yield indication.

OnBeginBusy	Event hook to give access to when the first process becomes active.
OnBeginYield	Event hook to give access to when the first process becomes active that was initiated with Yield as true.
OnEndBusy	Event hook to give access to when the last process is completed or aborted.
OnEndYield	Event to give access to when the last process is completed or aborted that was initiated with Yied as true.
OnSessionTimer	This provides a hook into the session timer that operated in the background.