Click or drag to resize

Window Class

X#
Provide the base class from which all X# windows are subclassed.
Inheritance Hierarchy
Object
  VObject
    EventContext
      Window
        AppWindow
        ControlWindow
        DialogWindow
        Printer

Namespace:  VO
Assembly:  VOGUIClasses (in VOGUIClasses.dll) Version: 2.19
Syntax
 CLASS Window INHERIT EventContext
Request Example View Source

The Window type exposes the following members.

Constructors
  NameDescription
Public methodWindow
Construct a Window object.
Top
Properties
  NameDescription
Public propertyAccelerator
The accelerator table associated with this window.
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.
Public propertyBackground
The background brush currently in use by this window.
Public propertyCanvasArea
The bounding box representing the current size of this window's canvas area.
Public propertyCaption
The string representing the caption (the text in the title bar of this window). This method can also be used to change the title of this window.
Public propertyContextMenu
A menu object representing the local pop-up menu for a window or window control.
Public propertyDragDropClient
The DragDropClient object created when Window:EnableDragDropClient(TRUE) is called.
Public propertyDragDropServer
The DragDropServer object created when Window:EnableDragDropServer(TRUE) is called.
Public propertyDragImageList
The ImageList object used for a drag-and-drop operation.
Public propertyFont
The font currently used by this window. This font is used by the TextObject:TextPrint() method.
Public propertyForeground
The foreground brush currently in use by this window.
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.
Public propertyHyperLabel
The hyperlabel connected to this window.
Public propertyIcon
The large icon object used for this window.
Public propertyIconSm
The small icon object used for this window.
Public propertyMenu
The menu currently in use by this window.
Public propertyMinSize
The minimum size for the window
Public propertyCode exampleOrigin
The point representing the new location of this window, in the canvas coordinates of its owner.
Public propertyOwner
The owner of the window, either a Window or App object.
Public propertyOwnerAlignment
The Owner Alignment value for the window, which is used when the window is a subwindow on another window.
Public propertyPen
The pen assigned to the window and used in subsequent line and rectangle drawing operations; it should not be deleted while it is the current selection.
Public propertyPointer
The pointer used by the window to represent the mouse when it enters the window.
Public propertyCode exampleSize
The dimension representing the size of this window.
Public propertyTextColor
Uses a pen object and builds a pen in this window.
Public propertyToolBar
The toolbar in use by the window.
Public propertyWindowArea
The bounding box representing the minimal area which encloses the entire window (canvas area and non-canvas area), in canvas coordinates.
Top
Methods
  NameDescription
Public methodActivate
Provide a method that is invoked when this window is activated.
Public methodAddTrayIcon
Adds a tray icon associated with the window.
Public methodAnimationStart
Provide a method that is invoked when an animation control begins playback.
Public methodAnimationStop
Provide a method that is invoked when an animation control ends playback.
Public methodAppCommand
Provide a method that is invoked when an AppCommand event takes place.
Public methodCode exampleButtonClick
Provide a method that is invoked when a check box, push button, or radio button is clicked with the mouse.
Public methodButtonDoubleClick
Provide a method that is invoked when a check box, push button, or radio button is double-clicked.
Public methodCanvasErase
Erase the current canvas area of this window and repaint it using either the background brush or the system's default background color.
Public methodCenter
Center the window on its owner, or if the owner is the dektop, then center the window on the desktop.
Public methodClose
Invoked just as the window is about to close.
Public methodComboBoxExEndEdit
A callback method that is invoked when a ComboBoxEx control sends an 'EndEdit' notification message
Public methodComboBoxExNotify
A callback method that is invoked when a ComboBoxEx control sends a notification message
Public methodControlNotify
Provide a method that is invoked when a control sends a notification to its parent window.
Public methodDateTimeSelectionChanged
Provide a method that is invoked when a DateTimePicker selection is changed.
Public methodDeActivate
Provide a method that is invoked when this window is deactivated.
Public methodDefault
Call the default windows procedure for a window and set the EventReturnValue for the object.
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()).
Public methodDispatch
Provide the dispatcher for events within the system when the window has focus; routing various events to their appropriate event handlers.
Public methodDraw
Display a Draw object on this window.
Public methodDrawBackground
Draw the background of a window.
Public methodDrop
Retrieve information about a load from the drag event and act on each file in the selection.
Public methodEditChange
Provide a method that is invoked when the text in an edit control is changed.
Public methodEditFocusChange
Provide a method that is invoked when the input focus changes to or from an edit control.
Public methodEditScroll
Provide a method that is invoked for this window when an edit control is scrolled.
Public methodEnable
Enable a previously disabled window.
Public methodEnableCloseBox
Enable or Disable the close button on a window (the X )
Public methodEnableDragDropClient
Allow "draggable" windows to be dropped on this window.
Public methodEnableDragDropServer
Allow this window to be dropped on windows with drag and drop capabilities.
Public methodEnableHelp
Enable or disable help for a window and its child windows.
Public methodEnableHelpButton
Enables the help button in the window caption bar.
Public methodEnableHelpCursor
Changes the cursor to a question mark with a pointer.
Public methodEnableThemeDialogTexture
Enables or disables the visual style of a dialog window's background.
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.
Public methodExpose
Provide a method that is invoked whenever part of the window needs repainting.
Public methodCode exampleFocusChange
Provide a method that is invoked when the input focus changes from the current window to another (or vice versa).
Public methodGetAllChildren
Obtain an array of all X# children objects of the window.
Public methodGetExStyle
Retrieve the Ex styles for the window.
Public methodGetStyle
Retrieve the styles for the window.
Public methodHandle
Return the handle for a window.
Public methodHasExStyle
Check if an exstyle value has been set for the window
Public methodHasStyle
Check if a style value has been set for the 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.
Public methodHide
Hide this window so it is not visible.
Public methodHorizontalScroll
Provide a method that is invoked when a horizontal scroll bar is scrolled.
Public methodHorizontalSlide
Provide a method that is invoked when a horizontal slider's thumb is dragged either by the mouse or the keyboard.
Public methodHorizontalSpin
Provide a method that is invoked when a horizontal spinner is spun.
Public methodIsEnabled
Report if this window is currently enabled.
Public methodIsIconic
Report if this window is currently iconized.
Public methodIsVisible
Report if this window is visible (completely or partially) or hidden.
Public methodIsZoomed
Report if this window is maximized (fills the entire screen).
Public methodKeyDown
Provide a method that is invoked when a key on the keyboard is pressed.
Public methodKeyUp
Provide a method that is invoked when a key on the keyboard is released.
Public methodLineTo
Draw a line on this window (using the current pen) from the current pen position to a specified point.
Public methodListBoxClick
Provide a method that is invoked when an item in a list box owned by this window is double-clicked.
Public methodCode exampleListBoxSelect
Provide a method that is invoked when an item in a list box owned by this window is clicked.
Public methodListViewColumnClick
Provide a method that is invoked when a list view column header is clicked in a list view control.
Public methodListViewItemChanged
Provide a method that is invoked when a list view item has changed.
Public methodListViewItemChanging
Provide a method that is invoked when the state of a list view item is about to change.
Public methodListViewItemDelete
Provide a method that is invoked when a list view item is deleted in a list view control.
Public methodListViewItemDrag
Provide a method that is invoked when a list view item is dragged in a list view control.
Public methodListViewItemEdit
Provide a method that is invoked when a list view item is edited in a list view control.
Public methodListViewKeyDown
Provide a method that is invoked when a key is pressed in a list view control.
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.
Public methodCode exampleListViewMouseButtonDown
Provide a method that is invoked when a mouse button is clicked in a list view control.
Public methodMenuCommand
Provide a method that is invoked when an item on a menu owned by this window is selected.
Public methodMenuInit
Provide a method that is invoked when a pop-up menu owned by this window is about to "pop up."
Public methodMenuSelect
Provide a method that is invoked when an item on a menu owned by this window is selected.
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).
Public methodModifyTrayIcon
Modify the tray icon associated with the window.
Public methodMonthCalSelectionChanged
Provide a method that is invoked when the selection of a MonthCalendar control is changed.
Public methodMouseButtonDoubleClick
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is double-clicked.
Public methodMouseButtonDown
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is clicked.
Public methodMouseButtonUp
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is released.
Public methodMouseDrag
Provide a method that is invoked when a mouse with one or more buttons clicked is moved in the window.
Public methodMouseMove
Provide a method that is invoked when the mouse is moved in the window.
Public methodMouseTrapOff
Disable the window from trapping MouseEvents generated outside itself.
Public methodMouseTrapOn
Enable this window to trap MouseEvents generated outside itself.
Public methodMove
Provide a method that is invoked when the window is moved (either by the user or by the application).
Public methodMoveTo
Move the current pen to a point on the window's canvas area.
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.
Public methodPaintBoundingBox
Paint a rectangular area in the window using a specified painting method.
Public methodPostInit
Implement customized initialization code for the window.
Public methodPreInit
Implement customized initialization code for the window.
Public methodPrint
Print the contents of the window.
Public methodCode exampleQueryClose
Provide a method that is invoked just before the window closes to confirm if the application really wants to close the window.
Public methodRegisterTimer
Register a timer method to be invoked for the window.
Public methodRePaint
Send an ExposeEvent to repaint the window's canvas area.
Public methodRepaintBoundingBox
Repaint a rectangular area in the window.
Public methodResize
Provide a method that is invoked when the window changes size.
Public methodRichEditProtected
Provide a method that is invoked when an attempt is made to modify text that is protected in a rich edit control.
Public methodRichEditSelectionChange
Provide a method that is invoked when the current selection in a rich edit control is changed.
Public methodRichEditUndoLost
Provide a method that is invoked when the undo state in a rich edit control can no longer be maintained.
Public methodScroll
Scroll a rectangular area in the window a specified amount, in a specified direction, and optionally clip the area when scrolled.
Public methodSetAlignStartSize
This method is used to register the start size of a window which is used later to resize controls that have their OwnerAlignment property set.
Public methodSetBackgroundBrush
Set the background brush used to paint the window.
Public methodSetExStyle
Set the extended style of a window.
Public methodSetFocus
Set the keyboard focus to this 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.
Public methodSetStyle
Set the styles for the window.
Public methodShow
Display this window.
Public methodShowBalloonTrayTip
Display a balloon tip for an icon in the tray that is associated with this window.
Public methodSizeText
Determine the space needed to print a string on the window in the current font.
Public methodStatusMessage
This is an empty method, since the Window class does not have a statusbar.
Public methodSysLinkSelect
Provide a method that is invoked when a a user clicks on a SysLink control.
Public methodTabKeyDown
Provide a method that is invoked when a key press occurs in a tab control.
Public methodTabSelect
Provide a method that is invoked when a tab is selected in a tab control.
Public methodTabSelectionChanging
Provide a method that is invoked when a tab selection is changing in a tab control.
Public methodTextPrint
Display a given string on the window at a specified location using the current font and the current pen color.
Public methodTimer
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
Public methodToolBarHeightChanged
Provide a method that is invoked when the height of the window's toolbar is changed.
Public methodToTop
Move this window "to the front" of the windows lying on the desktop, giving it the input focus.
Public methodTrayIconBalloonClicked
Provide a method that is invoked when a tray icon balloon is clicked.
Public methodTrayIconBalloonShown
Provide a method that is invoked when a tray icon balloon is shown.
Public methodTrayIconBalloonTimeOut
Provide a method that is invoked when a tray icon balloon times out.
Public methodTrayIconClicked
Provide a method that is invoked when a user clicks on a tray Icon
Public methodTreeViewItemDelete
Provide a method that is invoked when a tree view item is deleted in a tree view control.
Public methodTreeViewItemDrag
Provide a method that is invoked when a tree view item is dragged in a tree view control.
Public methodTreeViewItemEdit
Provide a method that is invoked when a tree view item is edited in a tree view control.
Public methodTreeViewItemExpanded
Provide a method that is invoked when a tree view item is expanded in a tree view control.
Public methodTreeViewItemExpanding
Provide a method that is invoked when a tree view item is expanding in a tree view control.
Public methodTreeViewKeyDown
Provide a method that is invoked when a key is pressed in a tree view control.
Public methodTreeViewMouseButtonDoubleClick
Provide a method that is invoked when a mouse button is double-clicked in a tree view control.
Public methodTreeViewMouseButtonDown
Provide a method that is invoked when a mouse button is clicked in a tree view control.
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.
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.
Public methodUpdate
Update the client area of the specified window.
Public methodVerticalScroll
Provide a method that is invoked when a vertical scroll bar is scrolled.
Public methodVerticalSlide
Provide a method that is invoked when a vertical slider's thumb is dragged either by the mouse or the keyboard.
Public methodVerticalSpin
Provide a method that is invoked when a vertical spinner is spun.
Top
Fields
  NameDescription
Public fieldEventReturnValue
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
Windows are central to every GUI. GUI windows can be thought of in two ways: As presentation objects with their visual representation on the screen As event handlers which process user interactions Each type of event goes to the appropriate event handler provided by subclasses of class Window. Event handler methods of the Window class are the system's default event handlers. By overriding these in subclasses, you change the behavior of your derived window from the default behavior provided by the Window class.
See Also

Reference