tlaPrintOutputPane
Print Contents of Any Pane of Output Window

CodeWright® - API Macro - Royalty Free - 2005.01.01 17:15
Send Comments

Purpose

Print Contents of Any Pane of Output Window.

This function extends an existing CodeWright capability.

Operation

The Starbase CodeWright API library contains a function called "Print the Output Window". This function was leveraged to create tlaPrintOutputPane.

The differences are that tlaPrintOutputPane ...

  • Prints the contents of any pane in the Output window instead of just the Search tab.

  • Doesn't prompt for printer information and instead uses the current settings.

  • Maintains the visibility (visible or not visible) status of the output window.

  • Uses an output filename that identifies the tab that was printed.

Issue the command with no parameters and the current pane of the output window will print using the current printer settings.

Issue the command with a valid pane number as a parameters and the designated pane of the output window will print (if supported) using the current printer settings.

Issue the command with an invalid pane number as a parameters and the current pane of the output window will print using the current printer settings.

Examples

tlaPrintOutputPane( )
tlaPrintOutputPane( 9 )

Input Parameters

Parm Name Code Meaning
1 Pane   Print current Output Window Pane.
number Print number Output Window pane.

Return Codes

Code Message
0  

Reference

None.

Compatibility

Current version verified under:

  • CodeWright 7.0b
  • CodeWright 7.0c
  • CodeWright 7.5.1
  • CodeWright 7.5.2
  • CodeWright for .NET 7.0 does not support this function

CodeWright for .NET Restriction

It is not currently possible to select a pane of the Output window under CodeWright for .NET.

Installation

There are three primary methods for installing this macro on your system. Method A uses the tlaMDE tool available for purchase from this website. Method B manipulates the macro repository directly. Method C uses the API Macro... tool provided in every copy of CodeWright (but not CodeWright for .NET).

Method A - tlaMDE - CodeWright or CodeWright for .NET

  • Select the Code button on this page.
  • When the second window opens, select all the text in the text box.
  • Issue Ctl-C (copy).
  • Create a new file in CodeWright or CodeWright for .NET.
  • Issue Ctl-V (paste).
  • Issue tlaMDE C (save and compile).

Method B - Copy to Repository - CodeWright or CodeWright for .NET

  • Select the Code button on this page.
  • When the second window opens, select all the text in the text box for a macro.
  • Issue Ctl-C (copy).
  • Load the macro repository "cwright.mac" from your CodeWright or CodeWright for .NET root:
  • issue Ctl-End to go to the end of file.
  • Issue Ctl-V (paste).
  • Close the file and respond yes to the write request.

Method C - API Macro ... - CodeWright Only

  • Select the Code button on this page.
  • When the second window opens, select text from the text box for a macro:
    • Do not select the [API Macro ... header line.
    • Select all other lines in the macro.
  • Issue Ctl-C (copy).
  • Open the CodeWright Tools | API Macros... dialog.
  • Press the New button.
  • Select the Edit box.
  • Issue Ctl-V (paste).
  • Double-click on the function name in the header of the macro.
  • Issue Ctl-C (copy).
  • Select the Name box.
  • Issue Ctl-V (paste).
  • Delete the trailing blank from the name.
  • Select the Save button.
  • Select the Close button.
  • Repeat this process for each macro in the text box.

Purchase

tlaTools is a Dynamic Link Library that contains most of the API macros on this website in a single easy to install package. The tlaTools DLL can be purchased by selecting the Buy button on this page.

tlaPrintOutputPane is included as a function in tlaTools.

Copyright © 1993-2005 Thom Little Associates, Ltd. revised 2005.01.01 17:15
One Central Square, Keene, NH 03431-3787 phone 603-357-7567