Skip to main content

Input Hidden

  • Updated

Input Hidden

This is the invisible member of the Input elements family, so some might say it's debatable whether it's actually a user input element at all. However, it's extremely useful.

Using It

This element does not appear on the report page and has no caption but it can serve either of two purposes:

  1. It can hold any data value that you want to pass discreetly. Because the POST method is used when the current page is submitted, the data does not appear in the URL's query string. Contrast this behavior to a Link Parameter, which is passed as part of the query string and is therefore visible in the browser's URL display. Input Hidden is especially useful when passing data from within Data Tables to another Report definition or a Process task (see Working with User Input Elements) and its value can be set using JavaScript.
  2. It can act as a "change flag", indicating to another Report definition or Process task whether or not any input data has been changed prior to the page being submitted. This can be used with conditional processing to determine, for example, whether or not a database record needs to be updated. For more information, see Working with Change Flags in Working with User Input Elements.

This element's two attributes are required: a unique element ID and a Default Value, which may be set using tokens.

New for 14.1 Adding HTML Attribute Params to your User Input elements enables you to apply your application to work with other frameworks or libraries easier. Depending on the type of HTML Attribute Params you add, there will be different parameters available to use, or you can define your own parameters. If an attribute was set in both Element and HTML Attribute Params, the one set in the HTML Attribute Params will be ignored.

New for 14.2 To turn off formula support for the Input Hidden element, add rdIgnoreFormula=True in the Template Modifier File. This ensures the text in the Input Hidden displays exactly as you enter it. Currently, the only character supported is the equal sign (=). Below is a usage example for rdIgnoreformula:

<TemplateModifier>
<SetAttribute XPath=“//InputHidden[@ID=‘rdCustomColumn1’]” rdIgnoreFormula=“True”></SetAttribute>
<SetAttribute XPath=“//Row[@ID=‘rowButtons’]/Column/Division[@ID=‘divDone’]/Label[@ID=‘lblDone’]/Action[@ID=‘rdActionDoneEmail’]” Javascript=“if(rdSaveSchedule(&apos;Refresh&apos;, &apos;true&apos;))rdHideSchedulePanel()“></SetAttribute>
<SetAttribute XPath=“//Row[@ID=‘rowButtons’]/Column/Division[@ID=‘divRunNow’]/Label[@ID=‘lblRunNow’]/Action[@ID=‘rdActionRunNow’]” Javascript=“rdRunNowSaveFirst(&apos;true&apos;)“></SetAttribute>
</TemplateModifier>

Getting Its Data

Input Hidden's value will be available in the next Report or Process task in a @Request token. For example, if the element's ID is set to hdnChangeFlag, then its data will be available in the token @Request.hdnChangeFlag~.

More Information

For additional information, see the Element Reference entry for Input Hidden.

Related articles