layout: default title: Tag Developers Guide

param

Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.

|

Description

{% comment %}start snippet id=javadoc|javadoc=true|url=org.apache.struts2.components.Param {% endcomment %}

Parameters

{% comment %}start snippet id=tagattributes|javadoc=false|url=struts2-tags/param.html {% endcomment %}

		<tr>

			<td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td>

		</tr>

		<tr>

			<td colspan="6">&nbsp;</td>

		</tr>

		<tr>

			<th align="left" valign="top"><h4>Name</h4></th>

			<th align="left" valign="top"><h4>Required</h4></th>

			<th align="left" valign="top"><h4>Default</h4></th>

			<th align="left" valign="top"><h4>Evaluated</h4></th>

			<th align="left" valign="top"><h4>Type</h4></th>

			<th align="left" valign="top"><h4>Description</h4></th>

		</tr>

			<tr>

				<td align="left" valign="top">name</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Name of Parameter to set</td>

			</tr>

			<tr>

				<td align="left" valign="top">suppressEmptyParameters</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Boolean</td>

				<td align="left" valign="top">Whether to suppress empty parameters</td>

			</tr>

			<tr>

				<td align="left" valign="top">value</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">The value of evaluating provided name against stack</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Value expression for Parameter to set</td>

			</tr>

	</table>

Examples

{% comment %}start snippet id=example|lang=xml|javadoc=true|url=org.apache.struts2.components.Param {% endcomment %}

 <pre>
 <ui:component>
  <ui:param name="key"     value="[0]"/>
  <ui:param name="value"   value="[1]"/>
  <ui:param name="context" value="[2]"/>
 </ui:component>
 </pre>

 <p>
 Whether to suppress empty parameters:
 </p>

 <pre>
 <s:url action="eventAdd">
   <s:param name="bean.searchString" value="%{bean.searchString}" />
   <s:param name="bean.filter" value="%{bean.filter}" />
   <s:param name="bean.pageNum" value="%{pager.pageNumber}" suppressEmptyParameters="true" />
 </s:url>
 </pre>

{% comment %}end snippet id=example|lang=xml|javadoc=true|url=org.apache.struts2.components.Param {% endcomment %}

{% comment %}start snippet id=exampledescription|javadoc=true|url=org.apache.struts2.components.Param {% endcomment %}