GME  13
Public Member Functions | Static Public Member Functions | Public Attributes | Properties
GME.CSharp.GMEConsole Class Reference

Automatically redirects console messages to the GME console output, if GME is available. Otherwise prints the output to System console. More...

Collaboration diagram for GME.CSharp.GMEConsole:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 GMEConsole ()
void Clear ()
 Clear the console.

Static Public Member Functions

static GMEConsole CreateFromProject (GME.MGA.MgaProject project)

Public Attributes

IGMEOLEApp gme = null
 The GME application variable.

Properties

TextWriter Error get
 Handles error messages The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Error.Write("RootFolder name error: {0}.", rf.Name); If console is initialized, the message appears in GME console, if not, then in standard error. If DEBUG is defined, it also appears in VS output window.
TextWriter Out [get]
 Prints messages. The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Out.Write("RootFolder name : {0}.", rf.Name);.
TextWriter Warning [get]
 Prints warning messages. The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Warning.Write("RootFolder name is not changed : {0}.", rf.Name);.
TextWriter Info [get]
 Proints info messages. The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Info.Write("RootFolder name is changed : {0}.", rf.Name);.

Detailed Description

Automatically redirects console messages to the GME console output, if GME is available. Otherwise prints the output to System console.

Definition at line 14 of file GMEConsole.cs.


Constructor & Destructor Documentation

Definition at line 26 of file GMEConsole.cs.


Member Function Documentation

void GME.CSharp.GMEConsole.Clear ( ) [inline]

Clear the console.

Definition at line 81 of file GMEConsole.cs.

static GMEConsole GME.CSharp.GMEConsole.CreateFromProject ( GME.MGA.MgaProject  project) [inline, static]

Definition at line 90 of file GMEConsole.cs.


Member Data Documentation

The GME application variable.

Definition at line 20 of file GMEConsole.cs.


Property Documentation

TextWriter Error GME.CSharp.GMEConsole.get

Handles error messages The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Error.Write("RootFolder name error: {0}.", rf.Name); If console is initialized, the message appears in GME console, if not, then in standard error. If DEBUG is defined, it also appears in VS output window.

Definition at line 43 of file GMEConsole.cs.

TextWriter GME.CSharp.GMEConsole.Info [get]

Proints info messages. The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Info.Write("RootFolder name is changed : {0}.", rf.Name);.

Definition at line 74 of file GMEConsole.cs.

TextWriter GME.CSharp.GMEConsole.Out [get]

Prints messages. The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Out.Write("RootFolder name : {0}.", rf.Name);.

Definition at line 52 of file GMEConsole.cs.

Prints warning messages. The message to be written. GME Console does not handle special characters and trims white-spaces. Example: GMEConsole.Warning.Write("RootFolder name is not changed : {0}.", rf.Name);.

Definition at line 63 of file GMEConsole.cs.


The documentation for this class was generated from the following file: