Click or drag to resize

Printer Class

X#
Create an object that represents a single print job.
Inheritance Hierarchy
Object
  VObject
    EventContext
      Window
        Printer

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

The Printer type exposes the following members.

Constructors
  NameDescription
Public methodPrinter
Construct a printer job.
Top
Properties
  NameDescription
Public propertyAccelerator
The accelerator table associated with this window.
(Inherited from 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.
(Inherited from Window.)
Public propertyBackground
The background brush currently in use by this window.
(Inherited from Window.)
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.
(Inherited from Window.)
Public propertyContextMenu
A menu object representing the local pop-up menu for a window or window control.
(Inherited from Window.)
Public propertyDragDropClient
The DragDropClient object created when Window:EnableDragDropClient(TRUE) is called.
(Inherited from Window.)
Public propertyDragDropServer
The DragDropServer object created when Window:EnableDragDropServer(TRUE) is called.
(Inherited from Window.)
Public propertyDragImageList
The ImageList object used for a drag-and-drop operation.
(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 window.
(Inherited from 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.
(Inherited from Window.)
Public propertyHyperLabel
The hyperlabel connected to this window.
(Inherited from Window.)
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 propertyMenu
The menu currently in use by this window.
(Inherited from Window.)
Public propertyMinSize
The minimum size for the window
(Inherited from Window.)
Public propertyCode exampleOrigin
The point representing the new location of this window, in the canvas coordinates of its owner.
(Inherited from Window.)
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.
(Inherited from 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.
(Inherited from Window.)
Public propertyPointer
The pointer used by the window to represent the mouse when it enters the window.
(Inherited from Window.)
Public propertyCode exampleSize
The dimension representing the size of this window.
(Inherited from Window.)
Public propertyTextColor
Uses a pen object and builds a pen in this window.
(Inherited from Window.)
Public propertyToolBar
The toolbar in use by the window.
(Inherited from Window.)
Top
Methods
  NameDescription
Public methodCode exampleAbort
Instruct the printer to abort the current print job.
Public methodActivate
Provide a method that is invoked when this window is activated.
(Inherited from Window.)
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 methodCode exampleButtonClick
Provide a method that is invoked when a check box, push button, or radio button is clicked with the mouse.
(Inherited from Window.)
Public methodButtonDoubleClick
Provide a method that is invoked when a check box, push button, or radio button is double-clicked.
(Inherited from Window.)
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.
(Inherited from Window.)
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 methodClose
Invoked just as the window is about to close.
(Inherited from Window.)
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 methodControlNotify
Provide a method that is invoked when a control sends a notification to its parent window.
(Inherited from Window.)
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.
(Inherited from Window.)
Public methodDefault
Call the default windows procedure for a window and set the EventReturnValue for the object.
(Inherited from Window.)
Public methodDestroy
Provide a method to de-instantiate a Printer object.
(Overrides Destroy.)
Public methodDisable
Disable this window (until a subsequent call to Enable()).
(Inherited from Window.)
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 Window.)
Public methodDraw
Display a Draw object on this window.
(Inherited from Window.)
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.
(Inherited from Window.)
Public methodEditFocusChange
Provide a method that is invoked when the input focus changes to or from an edit control.
(Inherited from Window.)
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 methodEnableCloseBox
Enable or Disable the close button on a window (the X )
(Inherited from Window.)
Public methodEnableDragDropClient
Allow "draggable" windows to be dropped on this window.
(Inherited from Window.)
Public methodEnableDragDropServer
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 methodEnableThemeDialogTexture
Enables or disables the visual style of a dialog window's background.
(Inherited from Window.)
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 methodExpose
Provide a method that is invoked whenever part of the window needs repainting.
(Inherited from Window.)
Public methodCode exampleFocusChange
Provide a method that is invoked when the input focus changes from the current window to another (or vice versa).
(Inherited from Window.)
Public methodGetAllChildren
Obtain an array of all X# children objects of the window.
(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 methodHandle
Return the handle for a window.
(Inherited from Window.)
Public methodHandle(Usual)
Return the handle for a printer.
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 window so it is not visible.
(Inherited from Window.)
Public methodHorizontalScroll
Provide a method that is invoked when a horizontal scroll bar is scrolled.
(Inherited from Window.)
Public methodHorizontalSlide
Provide a method that is invoked when a horizontal slider's thumb is dragged either by the mouse or the keyboard.
(Inherited from Window.)
Public methodHorizontalSpin
Provide a method that is invoked when a horizontal spinner is spun.
(Inherited from Window.)
Public methodIdle
Instruct the system to process events while printing.
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 methodIsValid
Determine if a printer is valid.
Public methodIsVisible
Report if this window is visible (completely or partially) or hidden.
(Inherited from Window.)
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 window (using the current pen) from the current pen position to a specified point.
(Inherited from Window.)
Public methodListBoxClick
Provide a method that is invoked when an item in a list box owned by this window is double-clicked.
(Inherited from Window.)
Public methodCode exampleListBoxSelect
Provide a method that is invoked when an item in a list box owned by this window is clicked.
(Inherited from Window.)
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 Window.)
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.
(Inherited from Window.)
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 is moved in the window.
(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 window's canvas area.
(Inherited from Window.)
Public methodNewPage
Direct the attached printer to eject to a new page.
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 window using a specified painting method.
(Inherited from 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 methodPrint
Print the contents of the window.
(Inherited from Window.)
Public methodPrinterError
Called if a printer error occurs. PrintErrorEvent is interrogated to identify the type of error has occurred.
Public methodPrinterExpose
Invoked for each page (or part of a page) of the print job whenever it needs repainting.
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.
(Inherited from Window.)
Public methodRegisterTimer
Register a timer method to be invoked for the window.
(Inherited from Window.)
Public methodRePaint
Send an ExposeEvent to repaint the window's canvas area.
(Inherited from Window.)
Public methodRepaintBoundingBox
Repaint a rectangular area in the window.
(Inherited from Window.)
Public methodResize
Provide a method that is invoked when the window changes size.
(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 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.
(Inherited from Window.)
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 methodSetStyle
Set the styles for the window.
(Inherited from Window.)
Public methodShow
Display this window.
(Inherited from Window.)
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 methodStart
Start a print job or contiguous portion of a print job.
Public methodStatusMessage
This is an empty method, since the Window class does not have a statusbar.
(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 window at a specified location using the current font and the current pen color.
(Inherited from Window.)
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 methodUpdate
Update the client area of the specified window.
(Inherited from Window.)
Public methodVerticalScroll
Provide a method that is invoked when a vertical scroll bar is scrolled.
(Inherited from Window.)
Public methodVerticalSlide
Provide a method that is invoked when a vertical slider's thumb is dragged either by the mouse or the keyboard.
(Inherited from Window.)
Public methodVerticalSpin
Provide a method that is invoked when a vertical spinner is spun.
(Inherited from Window.)
Top
Fields
  NameDescription
Public fieldEventReturnValue (Inherited from Window.)
Public fieldlprAbort
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
It is essential to check the validity of a Printer object—using Printer:IsValid()—before using it. To use a printer, the application should call Printer:Start(), which repeatedly calls Printer:PrinterExpose() for each page printed until the final page, in which it returns FALSE. Printer:Start() returns when the print job is finished. You can also: Determine the size of the page using Window:CanvasArea and Window:WindowArea to return the size of the printable area and total page size, respectively Scale the printout using Window:Size Determine the origin using Window:Origin (for example, to create margins) X# will only print the correct font if it exists for your printer; otherwise, the font that is most similar is used. Printing is done in printer coordinates, which are device dependent. Use the methods described here to scale and size your printout. Also note that for business printing, such as management reports, invoices, and notification letters, it is usually more convenient to design a report with the Report Editor and then run the report using the ReportQueue class. For more information, refer to the Programmer's Guide.
Examples
The following example prints the text "Hello World":
X#
 1METHOD PrinterExpose(oPEE) CLASS PrinterClass
 2SELF:TextPrint("Hello World",Point{30,30})
 3RETURN FALSE            // Nothing more to print
 4CLASS PrinterClass INHERIT Printer
 5METHOD Init() CLASS PrinterClass
 6SUPER:Init()
 7RETURN SELF
 8METHOD MenuCommand(oMCE) CLASS StandardShellWindow
 9LOCAL oPrinter AS PrinterClass
10IF(oMCE:ItemID = ;
11IDM_EMPTYSHELLMENU_FILE_PRINT_ID)
12// File Print menu item ID
13oPrinter := PrinterClass{}
14IF(oPrinter:IsValid())
15oPrinter:Start()
16oPrinter:Destroy()
17ENDIF
18ENDIF
See Also

Reference