OutputDocument.Create

Prototypes

static OutputDocument Create( String sName <, boolean bSetDefault, boolean bShow> )

static OutputDocument Create( <boolean bSetDefault, boolean bShow> )

Return Value

The return value is a reference to the newly created object of the OutputDocument class.

Parameters

String sName
The name to assign to the OutputDocument. This name is displayed in the title bar of the LISTING output document's window. The parameter sName must be either a valid Windows filename or null. If sName is null, IMLPlus generates a name for the LISTING output document. Calling this method without specifying the parameter sName is equivalent to calling it with sName equal to null.

boolean bSetDefault
If bSetDefault is true, the LISTING output document becomes the default LISTING output document. If bSetDefault is false and there is an existing LISTING output document, the designation of the default LISTING output document is not changed. Calling this method without specifying the parameter bSetDefault is equivalent to calling it with bSetDefault equal to true.

boolean bShow
If bShow is true, the window associated with the OutputDocument is displayed. If bShow is false, the window is hidden. Calling this method without specifying the parameter bShow is equivalent to calling it with bShow equal to true.

Remarks

This method creates a new LISTING output document. The parameter bSetDefault determines whether the new LISTING output document becomes the default LISTING output document. The default LISTING output document is the LISTING output document to which IMLPlus routes subsequent output. If the parameter bSetDefault is true, the new LISTING output document becomes the default LISTING output document. If bSetDefault is false and there is an existing LISTING output document, the designation of the default LISTING output document is not changed. If there are no existing LISTING output documents, the new LISTING output document becomes the default LISTING output document regardless of the value of bSetDefault.

LISTING output documents created by this method are initially configured as temporary LISTING output documents. When you rerun a program, IMLPlus automatically closes any temporary LISTING output documents created by the previous run. You can use the method OutputDocument.SetTemporary to control the temporary characteristic of a LISTING output document.

Example

declare OutputDocument doc1 = OutputDocument.Create();
declare OutputDocument doc2 = OutputDocument.Create();
doc1.SetWindowPosition(  0, 50, 50, 50 );
doc2.SetWindowPosition( 50, 50, 50, 50 );

do i = 1 to 200;
    doc1.SetDefault();
    /* simulated work stream #1 */
    x = T( ranuni( 1:5 ) );
    print x;

    doc2.SetDefault();
    /* simulated work stream #2 */
    x = T( ranuni( 1:5 ) );
    print x;
end;

See Also

OutputDocument.GetDefault
OutputDocument.SetDefault
OutputDocument.SetTemporary