ControlWindow Class |  |
Create a control as part of the Window hierarchy, thereby allowing the behavior of the control to be customized using event handlers.
Inheritance HierarchyNamespace: VO
Assembly: VOGUIClasses (in VOGUIClasses.dll) Version: 2.19
SyntaxThe ControlWindow type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | ControlWindow |
Construct a control window from an existing control.
|
Properties| Name | Description | |
|---|---|---|
 | Accelerator |
The accelerator table associated with this window.
(Inherited from Window.) |
| Automated |
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.) |
| Background |
The background brush currently in use by this window.
(Inherited from Window.) |
| CanvasArea |
The bounding box representing the current size of this window's canvas area.
(Inherited from Window.) |
| Caption |
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.
(Inherited from Window.) |
| ContextMenu |
A menu object representing the local pop-up menu for a window or window control.
(Inherited from Window.) |
| Control |
The control on which the control window is based.
|
| ControlID |
A number between 1 and 8000 representing the unique ID of the control on which the control window is based.
|
| DragDropClient |
The DragDropClient object created when Window:EnableDragDropClient(TRUE) is called.
(Inherited from Window.) |
| DragDropServer |
The DragDropServer object created when Window:EnableDragDropServer(TRUE) is called.
(Inherited from Window.) |
| DragImageList |
The ImageList object used for a drag-and-drop operation.
(Inherited from Window.) |
| Font |
The font currently used by this window. This font is used by the TextObject:TextPrint() method.
(Inherited from Window.) |
| Foreground |
The foreground brush currently in use by this window.
(Inherited from Window.) |
| HelpDisplay |
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.) |
| HyperLabel |
The hyperlabel connected to the control on which the control window is based.
(Overrides HyperLabel.) |
| Icon |
The large icon object used for this window.
(Inherited from Window.) |
| IconSm |
The small icon object used for this window.
(Inherited from Window.) |
| Menu |
The menu currently in use by this window.
(Inherited from Window.) |
| MinSize | The minimum size for the window (Inherited from Window.) |
| Modified |
A logical value indicating whether the control on which the control window is based has been changed by the user since it was last set.
|
| Origin |
A point representing the position of a control window on its owner window, in canvas coordinates.
(Overrides Origin.) |
| Owner |
The owner of the window, either a Window or App object.
(Inherited from Window.) |
| OwnerAlignment | The Owner Alignment value for the window, which is used when the window is a subwindow on another window. (Inherited from Window.) |
| Pen |
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.
(Inherited from Window.) |
| Pointer |
The pointer used by the window to represent the mouse when it enters the window.
(Inherited from Window.) |
| Size |
A dimension representing the size of a control window.
(Overrides Size.) |
| TextColor |
Uses a pen object and builds a pen in this window.
(Inherited from Window.) |
| ToolBar |
The toolbar in use by the window.
(Inherited from Window.) |
| WindowArea |
The bounding box representing the minimal area which encloses the entire window (canvas area and non-canvas area), in canvas coordinates.
(Inherited from Window.) |
Methods| Name | Description | |
|---|---|---|
| Activate |
Provide a method that is invoked when this window is activated.
(Inherited from Window.) |
| AddTrayIcon |
Adds a tray icon associated with the window.
(Inherited from Window.) |
| AnimationStart |
Provide a method that is invoked when an animation control begins playback.
(Inherited from Window.) |
| AnimationStop |
Provide a method that is invoked when an animation control ends playback.
(Inherited from Window.) |
| AppCommand |
Provide a method that is invoked when an AppCommand event takes place.
(Inherited from Window.) |
| ButtonClick |
Provide a method that is invoked when a check box, push button, or radio button is clicked with the mouse.
(Inherited from Window.) |
| ButtonDoubleClick |
Provide a method that is invoked when a check box, push button, or radio button is double-clicked.
(Inherited from Window.) |
| CanvasErase |
Erase the current canvas area of this window and repaint it using either the background brush or the system's default background color.
(Inherited from Window.) |
| Center | Center the window on its owner, or if the owner is the dektop, then center the window on the desktop. (Inherited from Window.) |
| Close |
Invoked just as the window is about to close.
(Inherited from Window.) |
| ComboBoxExEndEdit |
A callback method that is invoked when a ComboBoxEx control sends an 'EndEdit' notification message
(Inherited from Window.) |
| ComboBoxExNotify |
A callback method that is invoked when a ComboBoxEx control sends a notification message
(Inherited from Window.) |
| ControlNotify |
Provide a method that is invoked when a control sends a notification to its parent window.
(Inherited from Window.) |
| DateTimeSelectionChanged |
Provide a method that is invoked when a DateTimePicker selection is changed.
(Inherited from Window.) |
| DeActivate |
Provide a method that is invoked when this window is deactivated.
(Inherited from Window.) |
| Default | Call the default windows procedure for a window and set the EventReturnValue for the object. (Overrides Default(Usual).) |
| Destroy |
Free memory resources allocated for a ControlWindow object and its derived objects.
(Overrides Destroy.) |
| Disable |
Disable a control window, including its associated control (until a subsequent call to ControlWindow:Enable()).
(Overrides Disable.) |
| Dispatch |
Provide the dispatcher for events within the system when the window has focus;
routing various events to their appropriate event handlers.
(Overrides Dispatch(Usual).) |
| Draw |
Display a Draw object on this window.
(Inherited from Window.) |
| DrawBackground |
Draw the background of a window.
(Inherited from Window.) |
| Drop |
Retrieve information about a load from the drag event and act on each file in the selection.
(Inherited from Window.) |
| EditChange |
Provide a method that is invoked when the text in an edit control is changed.
(Inherited from Window.) |
| EditFocusChange |
Provide a method that is invoked when the input focus changes to or from an edit control.
(Inherited from Window.) |
| EditScroll |
Provide a method that is invoked for this window when an edit control is scrolled.
(Inherited from Window.) |
| Enable |
Enable a control window that was previously disabled.
(Overrides Enable.) |
| EnableCloseBox |
Enable or Disable the close button on a window (the X )
(Inherited from Window.) |
| EnableDragDropClient |
Allow "draggable" windows to be dropped on this window.
(Inherited from Window.) |
| EnableDragDropServer |
Allow this window to be dropped on windows with drag and drop capabilities.
(Inherited from Window.) |
| EnableHelp |
Enable or disable help for a window and its child windows.
(Inherited from Window.) |
| EnableHelpButton |
Enables the help button in the window caption bar.
(Inherited from Window.) |
| EnableHelpCursor |
Changes the cursor to a question mark with a pointer.
(Inherited from Window.) |
| EnableThemeDialogTexture |
Enables or disables the visual style of a dialog window's background.
(Inherited from Window.) |
| EnableToolTips |
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.) |
| Expose |
Provide a method that is invoked whenever part of the window needs repainting.
(Inherited from Window.) |
| FocusChange |
Provide a method that is invoked when the input focus changes from the current window to another (or vice versa).
(Inherited from Window.) |
| GetAllChildren |
Obtain an array of all X# children objects of the window.
(Inherited from Window.) |
| GetExStyle |
Retrieve the Ex styles for the window.
(Inherited from Window.) |
| GetStyle |
Retrieve the styles for the window.
(Inherited from Window.) |
| Handle |
Return the handle for a window.
(Inherited from Window.) |
| HasExStyle | Check if an exstyle value has been set for the window (Inherited from Window.) |
| HasStyle | Check if a style value has been set for the window (Inherited from Window.) |
| HelpRequest |
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.) |
| Hide |
Hide a control window and its associated control so it is not visible (until a subsequent call to ControlWindow:Show()).
(Overrides Hide.) |
| HorizontalScroll |
Provide a method that is invoked when a horizontal scroll bar is scrolled.
(Inherited from Window.) |
| HorizontalSlide |
Provide a method that is invoked when a horizontal slider's thumb is dragged either by the mouse or the keyboard.
(Inherited from Window.) |
| HorizontalSpin |
Provide a method that is invoked when a horizontal spinner is spun.
(Inherited from Window.) |
| IsEnabled |
Report if this window is currently enabled.
(Inherited from Window.) |
| IsIconic |
Report if this window is currently iconized.
(Inherited from Window.) |
| IsVisible |
Report if this window is visible (completely or partially) or hidden.
(Inherited from Window.) |
| IsZoomed |
Report if this window is maximized (fills the entire screen).
(Inherited from Window.) |
| KeyDown |
Provide a method that is invoked when a key on the keyboard is pressed.
(Inherited from Window.) |
| KeyUp |
Provide a method that is invoked when a key on the keyboard is released.
(Inherited from Window.) |
| LineTo |
Draw a line on this window (using the current pen) from the current pen position to a specified point.
(Inherited from Window.) |
| ListBoxClick |
Provide a method that is invoked when an item in a list box owned by this window is double-clicked.
(Inherited from Window.) |
| ListBoxSelect |
Provide a method that is invoked when an item in a list box owned by this window is clicked.
(Inherited from Window.) |
| ListViewColumnClick |
Provide a method that is invoked when a list view column header is clicked in a list view control.
(Inherited from Window.) |
| ListViewItemChanged |
Provide a method that is invoked when a list view item has changed.
(Inherited from Window.) |
| ListViewItemChanging |
Provide a method that is invoked when the state of a list view item is about to change.
(Inherited from Window.) |
| ListViewItemDelete |
Provide a method that is invoked when a list view item is deleted in a list view control.
(Inherited from Window.) |
| ListViewItemDrag |
Provide a method that is invoked when a list view item is dragged in a list view control.
(Inherited from Window.) |
| ListViewItemEdit |
Provide a method that is invoked when a list view item is edited in a list view control.
(Inherited from Window.) |
| ListViewKeyDown |
Provide a method that is invoked when a key is pressed in a list view control.
(Inherited from Window.) |
| ListViewMouseButtonDoubleClick |
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.) |
| ListViewMouseButtonDown |
Provide a method that is invoked when a mouse button is clicked in a list view control.
(Inherited from Window.) |
| MenuCommand |
Provide a method that is invoked when an item on a menu owned by this window is selected.
(Inherited from Window.) |
| MenuInit |
Provide a method that is invoked when a pop-up menu owned by this window is about to "pop up."
(Inherited from Window.) |
| MenuSelect |
Provide a method that is invoked when an item on a menu owned by this window is selected.
(Inherited from Window.) |
| MinMaxInfo |
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.) |
| ModifyTrayIcon |
Modify the tray icon associated with the window.
(Inherited from Window.) |
| MonthCalSelectionChanged |
Provide a method that is invoked when the selection of a MonthCalendar control is changed.
(Inherited from Window.) |
| MouseButtonDoubleClick |
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.) |
| MouseButtonDown |
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is clicked.
(Inherited from Window.) |
| MouseButtonUp |
Provide a method that is invoked when the mouse pointer is positioned over the window and a mouse button is released.
(Inherited from Window.) |
| MouseDrag |
Provide a method that is invoked when a mouse with one or more buttons clicked is moved in the window.
(Inherited from Window.) |
| MouseMove |
Provide a method that is invoked when the mouse is moved in the window.
(Inherited from Window.) |
| MouseTrapOff |
Disable the window from trapping MouseEvents generated outside itself.
(Inherited from Window.) |
| MouseTrapOn |
Enable this window to trap MouseEvents generated outside itself.
(Inherited from Window.) |
| Move |
Provide a method that is invoked when the window is moved (either by the user or by the application).
(Inherited from Window.) |
| MoveTo |
Move the current pen to a point on the window's canvas area.
(Inherited from Window.) |
| Override | This is a compatibility method that is no longer used or needed. (Overrides Override.) |
| PaintBackground |
Paint the background for a window with the brush or background object that was specified by the user.
(Inherited from Window.) |
| PaintBoundingBox |
Paint a rectangular area in the window using a specified painting method.
(Inherited from Window.) |
| PostInit |
Implement customized initialization code for the window.
(Inherited from Window.) |
| PreInit |
Implement customized initialization code for the window.
(Inherited from Window.) |
|
Print the contents of the window.
(Inherited from Window.) | |
| QueryClose |
Provide a method that is invoked just before the window closes to confirm if the application really wants to close the window.
(Inherited from Window.) |
| RegisterTimer |
Register a timer method to be invoked for the window.
(Inherited from Window.) |
| RePaint |
Send an ExposeEvent to repaint the window's canvas area.
(Inherited from Window.) |
| RepaintBoundingBox |
Repaint a rectangular area in the window.
(Inherited from Window.) |
| Resize |
Provide a method that is invoked when the window changes size.
(Inherited from Window.) |
| RichEditProtected |
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.) |
| RichEditSelectionChange |
Provide a method that is invoked when the current selection in a rich edit control is changed.
(Inherited from Window.) |
| RichEditUndoLost |
Provide a method that is invoked when the undo state in a rich edit control can no longer be maintained.
(Inherited from Window.) |
| Scroll |
Scroll a rectangular area in the window a specified amount, in a specified direction, and optionally clip the area when scrolled.
(Inherited from Window.) |
| SetAlignStartSize | 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. (Inherited from Window.) |
| SetBackgroundBrush |
Set the background brush used to paint the window.
(Inherited from Window.) |
| SetExStyle |
Set the extended style of a window.
(Inherited from Window.) |
| SetFocus |
Pass input focus to a control window, thereby directing all mouse and keyboard input to its associated control.
(Overrides SetFocus.) |
| SetHandle | 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.) |
| SetStyle |
Set the styles for the window.
(Inherited from Window.) |
| Show |
Display this window.
(Inherited from Window.) |
| ShowBalloonTrayTip |
Display a balloon tip for an icon in the tray that is associated with this window.
(Inherited from Window.) |
| SizeText |
Determine the space needed to print a string on the window in the current font.
(Inherited from Window.) |
| StatusMessage |
This is an empty method, since the Window class does not have a statusbar.
(Inherited from Window.) |
| SysLinkSelect |
Provide a method that is invoked when a a user clicks on a SysLink control.
(Inherited from Window.) |
| TabKeyDown |
Provide a method that is invoked when a key press occurs in a tab control.
(Inherited from Window.) |
| TabSelect |
Provide a method that is invoked when a tab is selected in a tab control.
(Inherited from Window.) |
| TabSelectionChanging |
Provide a method that is invoked when a tab selection is changing in a tab control.
(Inherited from Window.) |
| TextPrint |
Display a given string on the window at a specified location using the current font and the current pen color.
(Inherited from Window.) |
| Timer |
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Window.) |
| ToolBarHeightChanged |
Provide a method that is invoked when the height of the window's toolbar is changed.
(Inherited from Window.) |
| ToTop |
Move this window "to the front" of the windows lying on the desktop, giving it the input focus.
(Inherited from Window.) |
| TrayIconBalloonClicked |
Provide a method that is invoked when a tray icon balloon is clicked.
(Inherited from Window.) |
| TrayIconBalloonShown |
Provide a method that is invoked when a tray icon balloon is shown.
(Inherited from Window.) |
| TrayIconBalloonTimeOut |
Provide a method that is invoked when a tray icon balloon times out.
(Inherited from Window.) |
| TrayIconClicked |
Provide a method that is invoked when a user clicks on a tray Icon
(Inherited from Window.) |
| TreeViewItemDelete |
Provide a method that is invoked when a tree view item is deleted in a tree view control.
(Inherited from Window.) |
| TreeViewItemDrag |
Provide a method that is invoked when a tree view item is dragged in a tree view control.
(Inherited from Window.) |
| TreeViewItemEdit |
Provide a method that is invoked when a tree view item is edited in a tree view control.
(Inherited from Window.) |
| TreeViewItemExpanded |
Provide a method that is invoked when a tree view item is expanded in a tree view control.
(Inherited from Window.) |
| TreeViewItemExpanding |
Provide a method that is invoked when a tree view item is expanding in a tree view control.
(Inherited from Window.) |
| TreeViewKeyDown |
Provide a method that is invoked when a key is pressed in a tree view control.
(Inherited from Window.) |
| TreeViewMouseButtonDoubleClick |
Provide a method that is invoked when a mouse button is double-clicked in a tree view control.
(Inherited from Window.) |
| TreeViewMouseButtonDown |
Provide a method that is invoked when a mouse button is clicked in a tree view control.
(Inherited from Window.) |
| TreeViewSelectionChanged |
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.) |
| TreeViewSelectionChanging |
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.) |
| Update |
Update the client area of the specified window.
(Inherited from Window.) |
| VerticalScroll |
Provide a method that is invoked when a vertical scroll bar is scrolled.
(Inherited from Window.) |
| VerticalSlide |
Provide a method that is invoked when a vertical slider's thumb is dragged either by the mouse or the keyboard.
(Inherited from Window.) |
| VerticalSpin |
Provide a method that is invoked when a vertical spinner is spun.
(Inherited from Window.) |
Fields| Name | Description | |
|---|---|---|
 | EventReturnValue | (Inherited from Window.) |
| oCargo | Cargo slot. (Inherited from VObject.) |
Remarks
When a control is created as part of the Window hierarchy, it can trap events. For example, you might want to customize the appearance of controls (like changing the background and foreground colors) or modify their default key handling.
Manipulating a control via the ControlWindow class requires more overhead than those created by the subclasses of Control. Therefore, it is recommended that control windows be used only where special handling is needed (for example, to override the handling of certain events or call some window method on a control).
See Also