view release on metacpan or  search on metacpan

html/manual/OO/form.html  view on Meta::CPAN

    value. This method returns a list of key/value pairs where the key is
    the field name (currently doesn't obey vui setting) and the field value 
    (enumeration values are converted to text automatically). <P>

      The current implementation does allow for the specification of sort
      order, but in the future it will and then you should, as usual, put
      the return value into an array instead of a hash.

<P>
<DT><A NAME="getAttachment"><B>getAttachment()</B></A>
<PRE>
   $v = $f->getAttachment(-entry =&gt; scalar string,
                          -field =&gt; [ field1 ],
                          -file  =&gt; scalar string);
</PRE>

    This method allows you to retrieve an attachment from the given
    record. You must specify both the record's entry ID and the attachment
    field name. The <code>file</code> parameter is optional. If specified,
    the attachment will be written to the given filename. If not specified, 
    the attachment is returned as a scalar value.
<P>
<DT><A NAME="value2internal"><B>value2internal()</B></A>
<PRE>
  $v = value2internal(-field =&gt; scalar, -value =&gt; value);
</PRE>

    This is an internal routine used to translate enumeration values into
    text for a given field.

<P>
<DT><A NAME="internal2value"><B>internal2value()</B></A>
<PRE>
  $v = internal2value(-field =&gt; scalar, -id =&gt; scalar, -value =&gt; value);
</PRE>

    This is an internal routine used to translate enumeration text into
    enumeration values for a given field. You must specify either the field 
    or id parameter as well as the value parameter.

<P>
<DT><A NAME="setSort"><B>setSort()</B></A>
<PRE>
  $f->setSort("Field Name1", [<I>ARS::AR_SORT_ASCENDING</I> or <I>ARS::AR_SORT_DESCENDING</I>], 
              "Field Name2", [<I>ARS::AR_SORT_ASCENDING</I> or <I>ARS::AR_SORT_DESCENDING</I>], 
              ...);
</PRE>

    This method allows you to set the sort option (ascending or
    descending) for field names. Each field name must be followed
    by a sort option. The fields will be sorted in the order 
    they are listed in the parameter list.

<P>

</DL>


<HR>
<A HREF="../toc.html">Back to Table of Contents</A><BR>
Last updated 9 Jun 1999 by jcmurphy@buffalo.edu.
</BODY>
</HTML>