Home >	Contents >

Alpha TOC   |    Annotated TOC

filter

Defines a filter for the report data. If there is an embedded <param> tag in the context, then to display the filter, the <param> tag must not be null.

Syntax

<filter
       name="filter name"
      [required="true|false"]
       type="list type"
       caption="caption definition"
       key="HTTP request"
       radiovalue="true|false"
      />

Attributes

Name	Type	Required?	Default value	Description
name	string	✓	No default value.	Names the filter.
required	boolean	Χ	False	Defines whether the filter is required.
type	list (text|dbselect| date|radio|box|hidden)	✓	No default value.	Defines the type of filter.
caption	string	✓	No default value.	Defines a caption for the filter.
key	string	✓	No default value.	The HTTP request key to use for this filter.
radiovalue	string	@type=radio true, else false	No default value.	Defines the radio value group.

Children

<param>

Parents

<report>

Example

<filter name="filter-objectname" required="false" type="text" caption="name" key="filter-
objectname" caption="report_objecttypegroup_module_filter_objectname"/>