<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-Doc.
*
*  ProLinga-Doc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Doc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Doc.  If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->
<refentry id="cmd_clear">
  <refmeta>
    <refentrytitle>CLEAR Command</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>CLEAR</refname>
    <refpurpose>Clear data or screen reference items.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>CONTAINER</option> <replaceable>container_name</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>DATAMODEL</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>data_model_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>LISTSTORE</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>list_store_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>PICKLIST</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>pick_list_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>RECORD</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>table_name</replaceable>
                                        <arg><replaceable>.record_name</replaceable></arg>
                                      </arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>SCREENFIELD</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>screen_field_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>TABLE</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>table_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>TEXTDOC</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>text_document_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>TREESTORE</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>tree_store_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>VARGROUP</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>variable_group_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>CLEAR</command>
      <arg choice='plain'><option>XMLDOC</option> <group choice='req'>
                                      <arg choice='plain'><replaceable>xml_document_name</replaceable></arg>
                                      <arg choice='plain'><option>ALL</option></arg>
                                    </group>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_clear_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_clear">CLEAR</link> command clears data reference 
      objects and clears screen reference objects.
    </para>
  </refsect1>
  <refsect1 id="cmd_clear_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>container_name</replaceable></term>
	<listitem>
	  <simpara>
            Any hard coded container widget name or any data reference that 
            contains a valid and existing screen container widget. The 
            widget must exist on the active screen.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>data_model_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            data model name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>list_store_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            list store name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>pick_list_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            picklist name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>record_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            record name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>screen_field_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            screen field name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>table_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            table name. All data dictionaries of all records of the table 
            will be cleared.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>text_document_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            text document name. 
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>tree_store_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            tree store name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>variable_group_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            variable group name.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>xml_document_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string that contains a valid and existing 
            xml document name.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_clear_example">
    <title>Example</title>
<programlisting>
. . .
. . .
CLEAR RECORD Order
. . .
CLEAR CONTAINER Preview
. . .
. . .
</programlisting>
  </refsect1>

  <refsect1 id="cmd_clear_related">
    <title>Related Commands</title>
    <para>
      None.
    </para>
  </refsect1>

</refentry>

