GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Two — Language Overview (continued)

ConsoleOpen Function

Overview

The ConsoleOpen function opens default console window.

Syntax/Parameters

Syntax

int = ConsoleOpen ( [string caption], [string properties] );

Parameters

caption

An optional string for the console window’s caption.

properties

An optional string containing optional properties for the window. To use this parameter, the caption parameter must be provided.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

If the default console is already open or the script has been run from a command line without the GUI, the ConsoleOpen function will essentially do nothing. The default console is essential console id 0.

The optional parameter pairs are as follows (names are case-sensitive):

	Background	Sets the color of the window background as RGB in HTML, CSS form, or a standard name. The default background color is black.
	Color	Sets the text color as RGB in HTML, CSS form, or a standard name. The default color is ‘computer terminal’ green.
	FontName	Sets the font name. The font should be a monospaced font.
	FontSize	Sets the font size in 10ths of points. Note that depending on the font type, certain size ranges are not available.
	Height	Sets the height of the window in lines.
	Scrollbars	Adds or removes scrollbars. The default is to add scrollbars.
	Width	Sets the width of the window in characters.
	Wrap	If set to TRUE or non-zero, text will automatically wrap in the field.

 

Related Functions

ConsoleCreate — Creates a separate console window.

ConsolePrint — Prints a message to the default or specified console.

ConsoleToFile — Exports the content of a console window to a file as text.

ConsoleToString — Copies the content of a console window to a string.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.