<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="dispatch.xsl" ?>
<Object name="Console" project="SuperEdi">

  <Title>Console Object</Title>

  <Description>The Console object provides access to the dockable
    console window, which is used to present results of any
    operation or extended status information.</Description>

  <Keywords>Text, Write, WriteLine, WriteColor, WriteLineColor,
    Clear</Keywords>
  
  <!-- Properties -->

  <Property name="Text" type="string">
    <Description>
      Sets or returns string displayed in the console
      window. This is the default property.
    </Description>
  </Property>
  <Property name="Visible" type="boolean">
    <Description>
      Sets or returns whether the console window is visible on the screen.
    </Description>
  </Property>

  <!-- Methods -->

  <Method name="Clear">
	<Description>Deletes all text from the console window.</Description>
    <Syntax>application.Clear()</Syntax>
  </Method>

  <Method name="Write">
	<Description>Writes a specified string to the console window.</Description>
    <Syntax>application.Write( Text )</Syntax>
	<Parameter name="Text" type="string" />
  </Method>

  <Method name="WriteLine">
	<Description>Writes a specified string and newline character
	  to the console window.</Description>
    <Syntax>application.WriteConsole( Text )</Syntax>
	<Parameter name="Text" type="string" />
  </Method>

  <Method name="WriteColor">
	<Description>Writes a colored string to the console window.</Description>
    <Syntax>application.WriteConsole( Text, Color )</Syntax>
	<Parameter name="Text" type="string" />
	<Parameter name="Color" type="OLE_COLOR" />
  </Method>

  <Method name="WriteLineColor">
	<Description>Writes a colored string and newline character
	  to the console window.</Description>
    <Syntax>application.WriteConsole( Text, Color )</Syntax>
	<Parameter name="Text" type="string" />
	<Parameter name="Color" type="OLE_COLOR" />
  </Method>

  <Example language="JScript">
Console.WriteLineColor( "Red", 255 );
Console.WriteLineColor( "Gree", 255*256 );
Console.WriteLineColor( "Blue", 255*256*256 );
  </Example>

</Object>
