DataBrowser Class |
Namespace: VO
The DataBrowser type exposes the following members.
Name | Description | |
---|---|---|
DataBrowser |
Construct a data browser.
|
Name | Description | |
---|---|---|
Background |
The brush used for painting the background of this data browser.
(Overrides Background.) | |
Caption |
A string representing the caption of the data browser for use in its title bar.
(Overrides Caption.) | |
CellEdit |
Returns the edit control for the current cell when the DataBrowser is in edit mode. Otherwise a NULL_OBJECT is returned.
| |
ColumnCount |
A numeric value indicating the number of columns in the data browser.
| |
ContextMenu |
A menu object representing the local pop-up menu for a control.
(Inherited from Control.) | |
ControlID |
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.) | |
CurrentColumn |
The current data column in the data browser (i.e., the one that contains the cursor).
| |
EditFont |
Returns the edit font for the DataBrowser. This font can be changed with the ChangeFont() method.
| |
FieldSpec |
The field specification connected to the control.
(Inherited from Control.) | |
Font |
The font to be used for the text area of the data browser.
| |
HiBackground |
Returns the background brush for the Highlighted rows and cells in the Databrowser. This can be changed with the ChangeBackground() method.
| |
HyperLabel |
The hyperlabel connected to the control.
(Inherited from Control.) | |
Modified |
A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified.
(Inherited from Control.) | |
Name |
A string representing the name of the control.
(Inherited from Control.) | |
NameSym |
A symbol representing the name of the control.
(Inherited from Control.) | |
Origin |
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.) | |
Owner |
The owner window of the data browser.
(Overrides Owner.) | |
OwnerAlignment |
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.) | |
Pointer |
The Pointer object to be used in the text area of the data browser.
| |
ReadOnly |
Is the control readonly ?
(Inherited from Control.) | |
RowCount |
A numeric value indicating the number of rows in the data browser.
| |
Server |
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.) | |
Size |
A dimension representing the size of a control.
(Inherited from Control.) | |
Status |
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.) | |
TextColor |
The text color to be used for the text area of the data browser.
| |
TextValue |
A string representing the value held in the control.
(Inherited from Control.) | |
ToolTipText |
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.) | |
UseHLForToolTip |
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.) | |
Value |
The value held in the control, in whatever data type the control holds.
(Inherited from Control.) | |
ValueChanged |
A logical value representing whether the control's Value has been changed from its prior setting.
(Inherited from Control.) |
Name | Description | |
---|---|---|
Activate |
Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.) | |
AddColumn |
Add one or more columns to a data browser.
| |
AsString |
Return an identifying label for the data browser.
(Overrides AsString.) | |
CanUndo |
Determine if the most recent changes to a data browser column can be undone (using DataBrowser:Undo()).
| |
ChangeBackground |
Set a new background brush for this data browser.
| |
ChangeFont |
Set a new font in a particular area of the data browser.
| |
ChangeTextColor |
Set a new pen in a particular area of the data browser.
| |
Clear |
If one or more cells in the data browser are selected, clear their contents; if only some characters in a cell are selected, remove only those characters.
| |
ColPos |
Return the position of the currently focused column.
| |
ColumnFocusChange |
Provide a method that is invoked when the column focus is changed.
| |
ColumnMoved |
Provide a method that is invoked when a column is moved.
| |
ColumnReSize |
Provide a method that is invoked when a column is resized.
| |
Copy |
Copy the current selection in the data browser to the clipboard.
| |
Create |
Creates the underlying Win32 control
(Inherited from Control.) | |
Cut |
Cut the current selection in the data browser to the clipboard.
| |
Deactivate |
Provide a method that is invoked when the control has focus and a window is deactivated. (Inherited from Control.) | |
DEFAULT | Call the default windows procedure for a control and set the EventReturnValue. (Overrides DEFAULT(Usual).) | |
Destroy |
Provide a method to de-instantiate a DataBrowser object.
(Overrides Destroy.) | |
Disable |
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.) | |
DisableTheme |
Disable the WinXP theme for a control.
(Inherited from Control.) | |
Dispatch |
Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers. (Overrides Dispatch(Usual).) | |
Enable |
Enable a control that was previously disabled.
(Inherited from Control.) | |
EnableBorder |
Specify the border style of the data browser.
| |
EnableColumnMove |
Enable/disable whether the user can move (rearrange) columns in the data browser with the mouse. If this method is not called, the ability to move columns is enabled, by default.
| |
EnableColumnReSize |
Enable/disable whether the user can resize columns in the data browser with the mouse. If this method is not called, the ability to resize columns is enabled, by default.
| |
EnableColumnTitles |
Turn column titles on or off for the entire browser.
| |
EnableGrid |
Enable/disable the display of a grid. If this method is not called, the grid is enabled, by default.
| |
EnableHorizontalScroll |
Enable/disable horizontal scrolling of a data browser. If this method is not called, horizontal scrolling is enabled, by default.
| |
EnableHorizontalSplit |
Enable/disable a horizontal splitbar in the data browser.
| |
EnableVerticalScroll |
Enable/disable vertical scrolling of a data browser. If this method is not called, vertical scrolling is enabled, by default.
| |
EnableVerticalSplit |
Enable/disable a vertical splitbar in the data browser.
| |
Error |
Provide a method for handling error conditions raised during data browser processing.
| |
Expose |
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting. (Inherited from Control.) | |
FocusChange |
Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa). (Inherited from Control.) | |
GetColumn |
Retrieve a specified column in this data browser.
| |
GetExStyle |
Retrieve the Ex styles for the control.
(Inherited from Control.) | |
GetStyle |
Retrieve the styles for the control.
(Inherited from Control.) | |
Handle |
Return the handle for a control.
(Inherited from Control.) | |
HasBorder | Check if a border has been set for the control (Inherited from Control.) | |
HasStyle | Check if a style value has been set for the control (Inherited from Control.) | |
Hide |
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.) | |
HorizontalScroll |
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.) | |
IsEnabled |
Report if this control is currently enabled.
(Inherited from Control.) | |
IsExStyle | Check if a exstyle value has been set for the control (Inherited from Control.) | |
IsReadOnly |
Report if this control is currently readonly.
(Inherited from Control.) | |
IsStyle | Check if a style value has been set for the control (Inherited from Control.) | |
IsVisible |
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.) | |
KeyDown |
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed. (Inherited from Control.) | |
KeyUp |
Provide a method that is invoked when the control has focus and a key on the keyboard is released. (Inherited from Control.) | |
LinkDF |
Connect a control to a data field in a data server.
(Inherited from Control.) | |
MenuInit |
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.) | |
MenuSelect |
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.) | |
MouseButtonDoubleClick |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked. (Inherited from Control.) | |
MouseButtonDown |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked. (Inherited from Control.) | |
MouseButtonUp |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
(Inherited from Control.) | |
MouseDrag |
Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
(Inherited from Control.) | |
MouseMove |
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.) | |
Move |
Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
(Inherited from Control.) | |
Notify |
An event handler that reflects events that have occurred in the server connected to this data browser.
| |
OverRide | This is a compatibility method that is no longer used or needed. (Inherited from Control.) | |
Paste |
Paste the current contents of the clipboard into the current data browser cell.
| |
PerformValidations |
Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Inherited from Control.) | |
Refresh |
Forces the contents of the data browser to be updated from the data server.
| |
RegisterTimer |
Register a timer method to be invoked for the control.
(Inherited from Control.) | |
RemoveColumn |
Remove a column from this data browser.
| |
RePaint |
Send an ExposeEvent to repaint the control
(Inherited from Control.) | |
Resize |
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.) | |
RestoreUpdate |
Update this data browser visually and restore standard operation (after DataBrowser:SuspendUpdate() is called).
(Overrides RestoreUpdate.) | |
SetCaption |
Set the caption for the data browser title bar.
| |
SetColumn |
Replace an existing column in the data browser with another column.
| |
SetColumnFocus |
Set the column focus to a specified data column.
| |
SetExStyle |
Set the exstyle for the control.
(Inherited from Control.) | |
SetFocus |
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.) | |
SetParent |
Change the parent handle for the control.
(Inherited from Control.) | |
SetPointer |
Set a new pointer to be used when the mouse moves over a particular area of the data browser.
| |
SetStandardStyle |
Set the appearance of the data browser's caption areas.
| |
SetStyle |
Set the style for the control.
(Inherited from Control.) | |
Show |
Show this data browser.
(Overrides Show.) | |
SuspendUpdate |
Temporarily disable repainting of the data browser while data is being altered; painting resumes with a call to DataBrowser:RestoreUpdate().
(Overrides SuspendUpdate.) | |
Timer |
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.) | |
Undo |
Undo recent changes to a row in the data browser.
| |
Use |
Connect the data browser to a data server in a client-server relationship.
| |
Validate |
Determine whether the currently focused record is valid.
| |
ValidateControl | This method validates if the control has been created and when not then it triggers the control creation (Inherited from Control.) | |
VerticalScroll |
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.) |
Name | Description | |
---|---|---|
EventReturnValue | (Inherited from Control.) | |
oCargo | Cargo slot. (Inherited from VObject.) | |
ptrControlDefaultProc |
Tip |
---|
Static dependencies to the CATO3*.DLL files, which contain the DataBrowser and SplitWindow functionality, have been removed in this version of X#. Applications not using a data browser and/or split window no longer need these .DLLs. This leads to a smaller memory footprint, faster application startup, and smaller installations. |