api:case
Version 23.4.8843
api:case
Version 23.4.8843
The api:case keyword is used with the api:select keyword. The api:case keyword consists of a block of APIScript that is executed if the value in api:select matches the value in api:case.
Parameters
- value: The pattern or value to compare against the value specified in api:select.
- match: The type of matches to find to determine whether the case statement should be executed. The default value is “exact”, which requires an exact match of the value. Other supported types are “regex”, for regular expression matching, and “glob”, which supports a simple expression model similar to the one used in file-name patterns (e.g., *.txt). The .NET edition of the application uses the .NET Framework version of regular expression matching. The Java edition uses Java regular expression constructs.
Control Attributes
None
Examples
Display an icon based on the condition. The api:case elements match “CompanyA” and “CompanyB” in the company_name attribute and if any occurrences are found take the action associated with that case.
<api:select value="[company_name]">
<api:case value="CompanyA">
<img src="http://www.companya.com/favicon.ico" />
</api:case>
<api:case value="CompanyB">
<img src="http://www.companyb.com/favicon.ico" />
</api:case>
<api:default>
<img src="http://www.myhosting.com/generic.ico"/>
</api:default>
</api:select>
See Also
- api:select: Write a multiselect APIScript block.
- api:default: Write a default case for api:select.