Click or drag to resize

DataWindow Class (Typed)

X#
Create a data window which is capable of interacting intelligently with a data server.
Inheritance Hierarchy
Object
  VObject
    EventContext
      Window
        AppWindow
          ChildAppWindow
            DataWindow
              DataDialog
              OLEDataWindow

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.19
Syntax
 CLASS DataWindow INHERIT ChildAppWindow,  IMPLEMENTS ILastFocus
Request Example View Source

The DataWindow type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleDataWindow
Construct a data window.
Top
Properties
  NameDescription
Public propertyAccelerator
The accelerator table associated with this window.
(Inherited from Window.)
Public propertyAllowServerClose
A logical value specifying whether the server is automatically closed with the data window. By default, this is set to TRUE in the DataWindow:Init() method.
Public propertyAutomated
A logical value determining whether the window object is to be exposed as an OLE automation server. This is a convenient shortcut for the RegisterOLEAutomationObject() function. When the window is destroyed, the UnRegisterOLEAutomationObject() is automatically called.
(Inherited from Window.)
Public propertyAutoScroll
A data window scrolls automatically to any control which gains focus while tabbing, even if the control is not visible (for example, when the window is resized). By setting AutoScroll to FALSE, this automatic scrolling behavior is blocked.
Public propertyBackground
The background brush currently in use by this data window.
(Overrides Background.)
Public propertyBrowser
The DataBrowser object to use when this data window is displayed in browse view.
Public propertyBrowserClass
A symbol specifying the class used for the data window's browse mode. Valid values are: #DATABROWSER, #DATALISTVIEW, or any user-defined class. The default is #DATABROWSER.
Public propertyCanvasArea
The bounding box representing the current size of this window's canvas area.
(Inherited from Window.)
Public propertyCaption (Overrides Caption.)
Public propertyClipperKeys
A logical value indicating that the Clipper navigation keys (i.e., the Direction and Return keys) are to be used for this data window (TRUE if yes, FALSE if no).
Public propertyConcurrencyControl
A constant, identifying the mode of automatic concurrency control for this data window, determining when and how records are locked and released:
Public propertyContextMenu
The context menu attached to the window
(Overrides ContextMenu.)
Public propertyCurrentView
A symbol representing the view mode of the data window, as #BrowseView or #FormView.
Public propertyDeferUse
A logical value specifying whether the Use() operation for connecting the data window to the associated server should be deferred until the data window is first displayed.
Public propertyEventReturnValue (Inherited from Window.)
Public propertyFont
The font currently used by this window. This font is used by the TextObject:TextPrint() method.
(Inherited from Window.)
Public propertyForeground
The foreground brush currently in use by this data window.
(Overrides Foreground.)
Public propertyCode exampleHelpDisplay
The help display object currently used by this window. This help display object provides a connection between the help file to be displayed and this window.
(Inherited from Window.)
Public propertyHorizontalScrollBar (Inherited from AppWindow.)
Public propertyHyperLabel (Overrides HyperLabel.)
Public propertyIcon
The large icon object used for this window.
(Inherited from Window.)
Public propertyIconSm
The small icon object used for this window.
(Inherited from Window.)
Public propertyIsClosing (Inherited from Window.)
Public propertyMenu (Overrides Menu.)
Public propertyMinSize
The minimum size for the window
(Inherited from Window.)
Public propertyNameSym (Inherited from Window.)
Public propertyCode exampleOrigin
The point representing the new location of this data window, in the canvas coordinates of its owner.
(Overrides Origin.)
Public propertyOwner
The owner of the window, either a Window or App object.
(Inherited from Window.)
Public propertyOwnerAlignment
The Owner Alignment value for the window, which is used when the window is a subwindow on another window.
(Overrides OwnerAlignment.)
Public propertyPen (Overrides Pen.)
Public propertyPointer
The pointer used by the data window to represent the mouse when it enters the window.
(Overrides Pointer.)
Public propertyPreventAutoLayout
A logical value indicating that the AutoLayout behavior of the data window is blocked (TRUE if yes, FALSE if no). An empty data window does not create controls automatically when it first uses a new data server.
Public propertyQuitOnClose
A logical value. If set to TRUE, quits the application when this (main) window is closed. The default value is FALSE.
(Inherited from AppWindow.)
Public propertyResourceDialog (Inherited from Window.)
Public propertyServer
The DataServer object currently connected to this data window. If no server is connected, this value is NIL.
Public propertyCode exampleSize
The dimension representing the size of this data window in canvas coordinates.
(Overrides Size.)
Public propertyCode exampleStatus
A hyperlabel identifying the status of this data window after the last operation.
Public propertyTextColor
Uses a pen object and builds a pen in this window.
(Inherited from Window.)
Public propertyToolBar (Overrides ToolBar.)
Public propertyTopMost (Inherited from Window.)
Public propertyVerticalScrollBar (Inherited from AppWindow.)
Public propertyWindowArea
The bounding box representing the minimal area which encloses the entire window (canvas area and non-canvas area), in canvas coordinates.
(Inherited from Window.)
Top
Functions
  NameDescription
Public methodActivate
Provide a method that is invoked when this window is activated.
(Overrides Activate(Event).)
Public methodAddTrayIcon
Adds a tray icon associated with the window.
(Inherited from Window.)
Public methodAnimationStart
Provide a method that is invoked when an animation control begins playback.
(Inherited from Window.)
Public methodAnimationStop
Provide a method that is invoked when an animation control ends playback.
(Inherited from Window.)
Public methodAppCommand
Provide a method that is invoked when an AppCommand event takes place.
(Inherited from Window.)
Public methodAppend
Append a blank record to the data server connected to this data window and position the window on this new record.
Public methodButtonClick
Provide a method that is invoked when a check box, push button, or radio button is clicked with the mouse.
(Overrides ButtonClick(ControlEvent).)
Public methodButtonDoubleClick
Provide a method that is invoked when a check box, push button, or radio button is double-clicked.
(Inherited from Window.)
Public methodCancel
Discard all information entered in this data window and close the window.
Public methodCanvasErase
Erase the current canvas area of this data window and repaint it using either the background brush or the system's default background color.
(Overrides CanvasErase.)
Public methodCenter
Center the window on its owner, or if the owner is the dektop, then center the window on the desktop.
(Inherited from Window.)
Public methodChangeFont
Change the font used by this datawindow.
Public methodCheckStatus
Test the information currently displayed in the controls in this data window to see if it passes all validation rules defined to the connected server.
Public methodClear
Clear the current selection in this data window.
Public methodClearRelations
Public methodClose
Invoked just as the data window is about to close.
(Overrides Close(Event).)
Public methodComboBoxExEndEdit
A callback method that is invoked when a ComboBoxEx control sends an 'EndEdit' notification message
(Inherited from Window.)
Public methodComboBoxExNotify
A callback method that is invoked when a ComboBoxEx control sends a notification message
(Inherited from Window.)
Public methodCommit
Force all pending updates to this data window's server to be permanently written to disk.
Public methodContextMenuShow (Inherited from Window.)
Public methodControlFocusChange
Provide a method that is invoked when the input focus changes to or from a control.
(Overrides ControlFocusChange(ControlFocusChangeEvent).)
Public methodControlNotify
Provide a method that is invoked when a control sends a notification to its parent window.
(Inherited from Window.)
Public methodCopy
Copy the current selection in this data window to the clipboard.
Public methodCut
Delete the current selection in this data window and copy it to the clipboard.
Public methodDateTimeSelectionChanged
Provide a method that is invoked when a DateTimePicker selection is changed.
(Inherited from Window.)
Public methodDeActivate
Provide a method that is invoked when this window is deactivated.
(Overrides DeActivate(Event).)
Public methodDeactivateAllOLEObjects (Overrides DeactivateAllOLEObjects(Usual).)
Public methodDefault
Call the default windows procedure for a window and set the EventReturnValue for the object.
(Inherited from AppWindow.)
Public methodDelete
Delete the current record in the attached server and update the window based on the change.
Public methodDeleteValidated
Delete the current record in the attached server only if it passes its validation rules and update the window based on the change.
Public methodDestroy
Free memory resources allocated for a window and its derived objects.
(Overrides Destroy.)
Public methodDisable
Disable this window (until a subsequent call to Enable()).
(Inherited from Window.)
Public methodDisableConditionalControls
Disable those controls in this data window that have been registered with RegisterConditionalControls().
Public methodDispatch
Provide the dispatcher for events within the system when the window has focus; routing various events to their appropriate event handlers.
(Inherited from AppWindow.)
Public methodDraw
Display a Draw object on this data window.
(Overrides Draw(Usual).)
Public methodDrawBackground
Draw the background of a window.
(Inherited from Window.)
Public methodDrop
Retrieve information about a load from the drag event and act on each file in the selection.
(Inherited from Window.)
Public methodEditChange
Provide a method that is invoked when the text in an edit control is changed.
(Overrides EditChange(ControlEvent).)
Public methodEditFocusChange (Overrides EditFocusChange(EditFocusChangeEvent).)
Public methodEditScroll
Provide a method that is invoked for this window when an edit control is scrolled.
(Inherited from Window.)
Public methodEnable
Enable a previously disabled window.
(Inherited from Window.)
Public methodEnableBorder
Set the border style for an application window.
(Inherited from AppWindow.)
Public methodEnableCloseBox
Enable or Disable the close button on a window (the X )
(Inherited from Window.)
Public methodEnableConditionalControls
Enable those controls that have been registered with RegisterConditionalControls().
Public methodEnableDragDropClient(Logic)
Allow "draggable" windows to be dropped on this window.
(Inherited from Window.)
Public methodEnableDragDropClient(Logic, Logic)
Public methodEnableDragDropServer Obsolete.
Allow this window to be dropped on windows with drag and drop capabilities.
(Inherited from Window.)
Public methodEnableHelp
Enable or disable help for a window and its child windows.
(Inherited from Window.)
Public methodEnableHelpButton
Enables the help button in the window caption bar.
(Inherited from Window.)
Public methodEnableHelpCursor
Changes the cursor to a question mark with a pointer.
(Inherited from Window.)
Public methodCode exampleEnableHorizontalScroll
Enable/disable a window horizontal scroll bar in an application window.
(Inherited from AppWindow.)
Public methodEnableMaxBox
Enable/disable a maximize box in an application window.
(Inherited from AppWindow.)
Public methodEnableMinBox
Enable/disable a minimize box in an application window.
(Inherited from AppWindow.)
Public methodCode exampleEnableOleDropTarget
Register the window as an OLE drop target.
(Inherited from AppWindow.)
Public methodEnableStatusBar
Enable/disable a status bar in an application window.
(Overrides EnableStatusBar(Logic).)
Public methodCode exampleEnableSystemMenu
Enable/disable a system menu in an application window.
(Inherited from AppWindow.)
Public methodEnableThemeDialogTexture
Enables or disables the visual style of a dialog window's background.
(Inherited from Window.)
Public methodEnableToolBar
Enable/disable a toolbar in an application window.
(Inherited from AppWindow.)
Public methodEnableToolTips
Enable or disable the tooltips for a window. Note that assigning a value to Control:ToolTipText automatically enables the tooltip's display on the parent window.
(Inherited from Window.)
Public methodCode exampleEnableVerticalScroll
Enable/disable a window vertical scroll bar in an application window.
(Inherited from AppWindow.)
Public methodEndWindow
Remove this application window from view (passing control back to the routine which created the application window).
(Inherited from AppWindow.)
Public methodEndWindow(Logic)
Remove this application window from view (passing control back to the routine which created the application window).
(Inherited from AppWindow.)
Public methodError
Provide a method for handling error conditions raised during data window processing.
Public methodErrorMessage
Display a message in an error box.
(Inherited from AppWindow.)
Public methodExpose
Provide a method that is invoked whenever part of the data window needs repainting.
(Overrides Expose(ExposeEvent).)
Public methodFieldGet
Retrieve the current value of the indicated control in this data window (and the data server field associated with this control, if any).
Public methodFieldPut
Set the value of the control in this data window (and the data server field associated with this control, if any).
Public methodCode exampleFocusChange
Provide a method that is invoked when the input focus changes from the current data window to another window (or vice versa).
(Overrides FocusChange(FocusChangeEvent).)
Public methodGetAllChildren
Obtain an array of all X# children objects of the window.
(Inherited from Window.)
Public methodGetDlgItem (Inherited from Window.)
Public methodGetExStyle
Retrieve the Ex styles for the window.
(Inherited from Window.)
Public methodGetStyle
Retrieve the styles for the window.
(Inherited from Window.)
Public methodGoBottom
Position the data server connected to this data window on the last logical record and update the window based on the change.
Public methodGoTo
Position the data server connected to this data window on a specified record number and update the window based on the change.
Public methodGoTop
Position the data server connected to this data window on the first logical record and update the window based on the change.
Public methodHandle
Return the handle for a window.
(Inherited from Window.)
Public methodHasExStyle
Check if an exstyle value has been set for the window
(Inherited from Window.)
Public methodHasStyle
Check if a style value has been set for the window
(Inherited from Window.)
Public methodHelpRequest
Provide a method that is invoked when the user requests help from the application using one of the available context-sensitive help mechanisms.
(Inherited from Window.)
Public methodHide
Hide this data window so it is not visible.
(Overrides Hide.)
Public methodHorizontalScroll
Provide a method that is invoked when a horizontal scroll bar is scrolled.
(Overrides HorizontalScroll(ScrollEvent).)
Public methodHorizontalSlide
Provide a method that is invoked when a horizontal slider's thumb is dragged either by the mouse or the keyboard.
(Overrides HorizontalSlide(SliderEvent).)
Public methodHorizontalSpin
Provide a method that is invoked when a horizontal spinner is spun.
(Overrides HorizontalSpin(SpinnerEvent).)
Public methodInsertObject
Use the standard Insert Object dialog to insert an OLE object into the focused OLEObject of the data window.
Public methodIsEnabled
Report if this window is currently enabled.
(Inherited from Window.)
Public methodIsIconic
Report if this window is currently iconized.
(Inherited from Window.)
Public methodIsVisible (Overrides IsVisible.)
Public methodIsZoomed
Report if this window is maximized (fills the entire screen).
(Inherited from Window.)
Public methodKeyDown
Provide a method that is invoked when a key on the keyboard is pressed.
(Inherited from Window.)
Public methodKeyUp
Provide a method that is invoked when a key on the keyboard is released.
(Inherited from Window.)
Public methodLineTo
Draw a line on this data window (using the current pen) from the current pen position to a specified point.
(Overrides LineTo(Point).)
Public methodListBoxClick
Provide a method that is invoked when an item in a list box owned by this data window is double-clicked.
(Overrides ListBoxClick(ControlEvent).)
Public methodListBoxSelect
Provide a method that is invoked when an item in a list box owned by this data window is clicked.
(Overrides ListBoxSelect(ControlEvent).)
Public methodListViewColumnClick
Provide a method that is invoked when a list view column header is clicked in a list view control.
(Inherited from Window.)
Public methodListViewItemChanged
Provide a method that is invoked when a list view item has changed.
(Inherited from Window.)
Public methodListViewItemChanging
Provide a method that is invoked when the state of a list view item is about to change.
(Inherited from Window.)
Public methodListViewItemDelete
Provide a method that is invoked when a list view item is deleted in a list view control.
(Inherited from Window.)
Public methodListViewItemDrag
Provide a method that is invoked when a list view item is dragged in a list view control.
(Inherited from Window.)
Public methodListViewItemEdit
Provide a method that is invoked when a list view item is edited in a list view control.
(Inherited from Window.)
Public methodListViewKeyDown
Provide a method that is invoked when a key is pressed in a list view control.
(Inherited from Window.)
Public methodListViewMouseButtonDoubleClick
Provide a method that is invoked when a mouse button is double-clicked in a list view control. This could be used to invoke an "edit screen" for the selected item, print a report, etc. See the ListViewMouseButtonDown() method for sample syntax.
(Inherited from Window.)
Public methodCode exampleListViewMouseButtonDown
Provide a method that is invoked when a mouse button is clicked in a list view control.
(Inherited from Window.)
Public methodMenuCommand
Provide a method that is invoked when an item on a menu owned by this window is selected.
(Inherited from Window.)
Public methodMenuInit
Provide a method that is invoked when a pop-up menu owned by this window is about to "pop up."
(Inherited from Window.)
Public methodMenuSelect
Provide a method that is invoked when an item on a menu owned by this window is selected.
(Inherited from AppWindow.)
Public methodMinMaxInfo
Provide a method that is invoked when the size or position of a window is about to change (cf WM_GETMINMAXINFO in Win API).
(Inherited from Window.)
Public methodModifyTrayIcon
Modify the tray icon associated with the window.
(Inherited from Window.)
Public methodMonthCalSelectionChanged
Provide a method that is invoked when the selection of a MonthCalendar control is changed.
(Inherited from Window.)
Public methodMouseButtonDoubleClick
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is double-clicked.
(Inherited from Window.)
Public methodMouseButtonDown
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is clicked.
(Overrides MouseButtonDown(MouseEvent).)
Public methodMouseButtonUp
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is released.
(Inherited from Window.)
Public methodMouseDrag
Provide a method that is invoked when a mouse with one or more buttons clicked is moved in the window.
(Inherited from Window.)
Public methodMouseMove
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is released.
(Inherited from Window.)
Public methodMouseTrapOff
Disable the window from trapping MouseEvents generated outside itself.
(Inherited from Window.)
Public methodMouseTrapOn
Enable this window to trap MouseEvents generated outside itself.
(Inherited from Window.)
Public methodMove
Provide a method that is invoked when the window is moved (either by the user or by the application).
(Inherited from Window.)
Public methodMoveTo
Move the current pen to a point on the data window's canvas area.
(Overrides MoveTo(Point).)
Public methodNotify
An event handler that reflects events that have occurred in the server connected to this data window.
Important! Notify() is automatically called by the server, and should normally not be called by application code.
Public methodOK
Accept all information entered in this data window and close the window.
Public methodOLEDragEnter
Called whenever the mouse enters the window's client area during a drag and drop operation.
(Inherited from AppWindow.)
Public methodOLEDragLeave
Called whenever the mouse leaves the window's client area during a drag and drop operation.
(Inherited from AppWindow.)
Public methodOLEDragOver
Called whenever the mouse moves within the window's client area during a drag and drop operation.
(Inherited from AppWindow.)
Public methodCode exampleOLEDrop
Called whenever the mouse is released within the window's client area during a drag and drop operation.
(Inherited from AppWindow.)
Public methodCode exampleOLEInPlaceActivate
Called whenever a child OLE object is about to be "inplace" activated.
(Overrides OLEInPlaceActivate.)
Public methodCode exampleOLEInPlaceDeactivate
Called whenever a child OLE object is about to be "inplace" deactivated.
(Overrides OLEInPlaceDeactivate.)
Public methodOnMdiChildActivated (Inherited from Window.)
Public methodOverride
This is a compatibility method that is no longer used or needed.
(Inherited from EventContext.)
Public methodPaintBackground
Paint the background for a window with the brush or background object that was specified by the user.
(Inherited from Window.)
Public methodPaintBoundingBox
Paint a rectangular area in the data window using a specified painting method.
(Overrides PaintBoundingBox(BoundingBox, Long).)
Public methodPaste
Replace the current selection in this data window with the contents of the clipboard.
Public methodPasteSpecial
Use the standard Paste Special dialog to insert an OLE object into the focused OLEObject of the data window.
Public methodPostInit
Implement customized initialization code for the window.
(Inherited from Window.)
Public methodPreInit
Implement customized initialization code for the window.
(Inherited from Window.)
Public methodPreMenuCommand (Inherited from Window.)
Public methodPreValidate
Called after any status change in this data window to allow controls and menu commands to be enabled/disabled based on the current validation status.
Public methodPrint
Print the contents of the window.
(Inherited from Window.)
Public methodQueryClose
Provide a method that is invoked just before the data window closes to confirm if the application really wants to close the window.
(Overrides QueryClose(Event).)
Public methodRegisterConditionalControls
Register a control in this data window as being subject to validation status and hence automatically dimmed whenever the window is in an invalid state.
Public methodRegisterTimer
Register a timer method to be invoked for the window.
(Inherited from Window.)
Public methodRePaint
Send an ExposeEvent to repaint the data window's canvas area.
(Overrides RePaint.)
Public methodRepaintBoundingBox
Repaint a rectangular area in the data window.
(Overrides RepaintBoundingBox(BoundingBox).)
Public methodReportException
This is a compatibility method that is no longer used or needed.
(Inherited from AppWindow.)
Public methodCode exampleReportNotification
Called by ReportQueue when it has a message for the owner window.
(Inherited from AppWindow.)
Public methodResize
Provide a method that is invoked when the window changes size.
(Inherited from Window.)
Public methodResumeLayout (Inherited from Window.)
Public methodRichEditProtected
Provide a method that is invoked when an attempt is made to modify text that is protected in a rich edit control.
(Inherited from Window.)
Public methodRichEditSelectionChange
Provide a method that is invoked when the current selection in a rich edit control is changed.
(Inherited from Window.)
Public methodRichEditUndoLost
Provide a method that is invoked when the undo state in a rich edit control can no longer be maintained.
(Inherited from Window.)
Public methodScroll
Scroll a rectangular area in the window a specified amount, in a specified direction, and optionally clip the area when scrolled.
(Inherited from Window.)
Public methodSeek
Search for a value in the data server connected to this data window based on a controlling search order and update the window based on the change.
Public methodSetAlignStartSize
Sets the start size of the form window. In general, this size is set with the first assign to OwnerAlignment but it can be useful when trying to control the sizes for yourself.
(Overrides SetAlignStartSize(Dimension).)
Public methodSetBackgroundBrush
Set the background brush used to paint the window.
(Inherited from Window.)
Public methodSetExStyle
Set the extended style of a window.
(Inherited from Window.)
Public methodSetFocus
Set the keyboard focus to this window.
(Inherited from Window.)
Public methodSetHandle
This methdod allows to set or change the handle of the window. This is normally done right after the window is created.
(Inherited from Window.)
Public methodCode exampleSetRelation
Set a relation from the data server connected to this data window to the data server of another, creating an owner-child relationship between the two servers and the two windows.
Public methodCode exampleSetSelectiveRelation
Set a selective relation from this window to the child window, or actually from the server of this window to the server of the other window. A selective relation is one that limits operations on the child server to those records that match the relation condition.
Public methodSetStyle
Set the styles for the window.
(Inherited from Window.)
Public methodShow
Display a window.
(Overrides Show(Usual).)
Public methodShowBalloonTrayTip
Display a balloon tip for an icon in the tray that is associated with this window.
(Inherited from Window.)
Public methodSizeText
Determine the space needed to print a string on the window in the current font.
(Inherited from Window.)
Public methodSkip
Move forward or backward in the server by a specified number of records.
Public methodSkipNext
Move to the next record (identical to Skip(1)).
Public methodSkipPrevious
Move to the previous record (identical to Skip(-1)).
Public methodStatusMessage
Display a message in an application window's status bar.
(Inherited from AppWindow.)
Public methodStatusOK
Indicate the current validation status of the window through a return code and by setting the DataWindow:Status property.
Public methodSuspendLayout (Inherited from Window.)
Public methodSysLinkSelect
Provide a method that is invoked when a a user clicks on a SysLink control.
(Inherited from Window.)
Public methodTabKeyDown
Provide a method that is invoked when a key press occurs in a tab control.
(Inherited from Window.)
Public methodTabSelect
Provide a method that is invoked when a tab is selected in a tab control.
(Inherited from Window.)
Public methodTabSelectionChanging
Provide a method that is invoked when a tab selection is changing in a tab control.
(Inherited from Window.)
Public methodTextPrint
Display a given string on the data window at a specified location using the current font and the current pen color.
(Overrides TextPrint(String, Point).)
Public methodTimer
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Window.)
Public methodToolBarHeightChanged
Provide a method that is invoked when the height of the window's toolbar is changed.
(Inherited from Window.)
Public methodToTop
Move this window "to the front" of the windows lying on the desktop, giving it the input focus.
(Inherited from Window.)
Public methodTrayIconBalloonClicked
Provide a method that is invoked when a tray icon balloon is clicked.
(Inherited from Window.)
Public methodTrayIconBalloonShown
Provide a method that is invoked when a tray icon balloon is shown.
(Inherited from Window.)
Public methodTrayIconBalloonTimeOut
Provide a method that is invoked when a tray icon balloon times out.
(Inherited from Window.)
Public methodTrayIconClicked
Provide a method that is invoked when a user clicks on a tray Icon
(Inherited from Window.)
Public methodTreeViewItemDelete
Provide a method that is invoked when a tree view item is deleted in a tree view control.
(Inherited from Window.)
Public methodTreeViewItemDrag
Provide a method that is invoked when a tree view item is dragged in a tree view control.
(Inherited from Window.)
Public methodTreeViewItemEdit
Provide a method that is invoked when a tree view item is edited in a tree view control.
(Inherited from Window.)
Public methodTreeViewItemExpanded
Provide a method that is invoked when a tree view item is expanded in a tree view control.
(Inherited from Window.)
Public methodTreeViewItemExpanding
Provide a method that is invoked when a tree view item is expanding in a tree view control.
(Inherited from Window.)
Public methodTreeViewKeyDown
Provide a method that is invoked when a key is pressed in a tree view control.
(Inherited from Window.)
Public methodTreeViewMouseButtonDoubleClick
Provide a method that is invoked when a mouse button is double-clicked in a tree view control.
(Inherited from Window.)
Public methodTreeViewMouseButtonDown
Provide a method that is invoked when a mouse button is clicked in a tree view control.
(Inherited from Window.)
Public methodTreeViewSelectionChanged
Provide a method that is invoked when the selection has changed from one tree view item to another in a tree view control.
(Inherited from Window.)
Public methodTreeViewSelectionChanging
Provide a method that is invoked when the selection is changing from one tree view item to another in a tree view control.
(Inherited from Window.)
Public methodUndo
Undo recent changes made in this data window.
Public methodUndoAll
Undo all changes made in this data window since the last record movement or Commit() operation.
Public methodUpdate
Update the client area of the specified window.
(Inherited from Window.)
Public methodUpdateActiveObject
Update the toolbars of any in-place active OLE objects.
Public methodUse
Connect the data window to a data server in a client-server relationship.
Public methodValidateRecord
Public methodVerticalScroll
Provide a method that is invoked when a vertical scroll bar is scrolled.
(Overrides VerticalScroll(ScrollEvent).)
Public methodVerticalSlide
Provide a method that is invoked when a vertical slider's thumb is dragged either by the mouse or the keyboard.
(Overrides VerticalSlide(SliderEvent).)
Public methodVerticalSpin
Provide a method that is invoked when a vertical spinner is spun.
(Overrides VerticalSpin(SpinnerEvent).)
Public methodViewAs
Specify the view mode of the data window, as browse view or form view.
Public methodViewForm
Select form view for the data window.
Public methodViewTable
Select browse view for the data window.
Public methodWarningMessage
Display a message in an warning box.
(Inherited from AppWindow.)
Top
Globals and Defines
  NameDescription
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
Data windows combine the properties and behavior of both child windows and dialog windows, and add data-aware behavior that enables them to interact intelligently with data servers. When connected to a data server, a data window forms a view of the server that allows for direct access and manipulation of the server's data. Unlike the other types of windows, a data window takes on different behavior depending on how it is used. It adapts itself to the demands placed on it by its owner, behaving differently depending on the circumstances: If Owner Is Data Window Acts Like ChildAppWindow Modal DialogWindow DataWindow Modal DialogWindow (if no placement is specified) or nested sub-data window (if placement is specified) DialogWindow Modal DialogWindow ShellWindow ChildAppWindow TopAppWindow Modal DialogWindow A data window can be placed on a data window in an owner-child relationship (similar to other controls like check boxes and radio buttons). When a data window is placed on another data window in this way, it is referred to as a sub-data window. Note that only a data window can own a sub-data window because it is the only window type of window that can deal with data-related events. You can create a data window as a sub-data window when the data window is created. You can optionally specify a third parameter (nResourceID), indicating that the new data window should be created as a control on a window by giving its location and size. When placed like a control, the data window hides its border decoration and behaves like a sub-data window. (If this parameter is omitted, the data window is created as a modal DialogWindow, not a sub-data window.) See DataWindow:Init() for details. Tip: Instead of newly creating a data window, you may prefer to use the Window Editor's Auto Layout feature which—at the touch of a button—automatically creates controls for every available field in a data window's associated data server(s). See "Using the Window Editor" in the IDE User Guide. A data window is connected to a server with the Use() method. When this connection is established, each control on the window is connected to a field in the data server based on matching names: a field named CustName is connected to the control named CustName. The control always reflects the current value of the data in the data server, and assigning a value to a control automatically propagates it to the server. Data windows can be associated with data servers in two ways: in a single server or dual server (master detail) relationship. The Master-Detail option allows you to link a window to two data servers in a master-detail relationship. In this case, a data window is created for the master server with a nested sub-data window for the detail server. The field list presented is taken from the Master data server. The field that you choose is used to perform a SetSelectiveRelation() to the detail server based on its controlling order. If you do not choose a field, the detail window is updated relative to the current record position in the master window. A data window can take on two different view modes: form view, which contains individual controls for the data fields and browse view, which contains a spreadsheet-like data browser. The data window can be initially displayed in either mode, and can be switched to the other mode at any time (using the DataWindow:ViewAs() method). Any data window supports both appearances, although the developer can, of course, choose not to provide a way to select one mode or the other. The two view modes provide the same set of facilities: the same data linkage facilities, the same display options, the same data manipulation methods. From the perspective of the application, a data window has the same behavior and the same data properties regardless of view mode. The standard way of using a data window is to paint its layout in the Window Editor. This produces a resource entity that specifies what controls the window has, and their locations, sizes, captions, and accelerators. It also generates a data window subclass and an Init() method that associates names and further annotation with each control. With such a predefined layout, the window is displayed very quickly and the methods of the window have enough information to act intelligently. A data window can also be created without a resource entity. In this case, the layout of controls on the window is automatically generated when the window is connected to a data server. After a layout is automatically generated, the window has exactly the same behavior that it has with a resource-based instantiation. If a data window is switched over to a new view mode, and the new mode has not been defined through a resource entity or programmatically, the data window automatically creates a layout based on the characteristics of the connected data server. The new layout picks up all information about fields and controls that is known to the other view; thus, if complex validation rules, prompts, and help have been specified for the individual controls in form view, the columns of the browse view inherit the same properties. When a control is connected to a field in a data server, a value entered into the control or assigned to the appropriate name from the program is automatically propagated to the server. Thus, after executing this statement:
X#
1oCustomerWindow:CustName := x
the CustName field in the server has the correct value. Values are propagated up from the data server to the data window when the server repositions itself, or when another window makes a change. This requires no special action: after executing a Skip() method or assigning a value to a field, every window connected to the server is automatically updated to reflect the change. Data entered by the user is automatically validated using the rules of the field specification attached to a control or column. (For more detail on the validation rules provided, see the FieldSpec class.) If data fails the validation test, the data window will not propagate invalid information down to the server or to other windows, nor will it take any action that requires writing the invalid value to the server. In addition to the field-specific validations, the system allows the specification of a ValidateRecord() method for the window as a whole, for the purpose of cross-field validation. This method, if provided, is called after all the fields have passed their individual validations. The data window also provides for registering controls that are subject to the validation status. Such registered controls are disabled whenever the window's validation status is bad. The data window class also provides action methods that correspond to the general capabilities of all data servers: GoTop(), GoTo(), GoBottom(), SkipNext(), SkipPrevious(), Append(), Delete(), and so on. The data window versions of these methods verify the validation status of the controls on the window. If everything is valid, the window invokes the corresponding method of the data server. The data window provides built-in facilities for concurrency control, automatically taking and releasing record locks as appropriate. Once the appropriate mode has been selected by assigning one of the available modes to DataWindow:ConcurrencyControl, record movements and changes use the concurrency control facilities of the data server to take and release locks. If taking a lock fails because another user controls the record, the data window action fails.
See Also