Report Options

Report Options allow parameters to be specified in the report and can be either set by the system, or optionally by the user.  

Attributes

id

a unique ID that allows the option to be referenced by the application and by the report.

caption

the caption that will be displayed to the user along with the control in an HTML report.

type

the type of control.  Available types are:

  1. LIST
  2. TEXT
  3. DATE
  4. CHECKBOX

defaultValue

the default value for the option. The value can be an absolute value, the id of an optionItem, or one of the following codes:

  1. EOFY - end of financial year
  2. SOFY - start of financial year
  3. RD - report date
  4. TODAY - today
  5. FIRST - first element in a list
  6. LAST - last element in a list

isVisible

if false, then the option will not be displayed to the user, but can still be referenced by the application and by the report.

data

If specified, then the report builder will use the GetReportOptions callback to populate this list with values from the database.

defaultIndex

the default index for lists can be set to:

  1. FIRST
  2. SECOND
  3. MIDDLE
  4. LAST
style
allows the option to be styled in various ways:
  1. NEWLINE - start the option on a new line
Example

<moxydoc:options>

   <moxydoc:option caption="From" id="fromDate" type="DATE" defaultValue="SOFY" />

   <moxydoc:option caption="To" id="toDate" type="DATE" defaultValue="EOFY" />

   <moxydoc:option caption="Contact" id="contactId" type="LIST" data="CONTACTS" defaultValue="ALL">

     <moxydoc:optionItem key="ALL" value="All contacts" />

   </moxydoc:option>

</moxydoc:options>


Click to see Comments

Help comments powered by Disqus