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