Miscellaneous Functions
CellValue
|
Description |
Returns the value of the current cell. |
|
Remark |
This function is only used in Conditional Formatting. |
|
Example |
Suppose a cell of a report displays the price of products. Ex. CellValue()> 150 returns True if the price of the product is greater than 150. |
FilterValue
|
Description |
Returns the current value of a filter as a string for display purposes. |
|
Remark |
Takes three arguments. 1. The index of the filter. 2. The sub-index used for filters that contain multiple values (i.e. between or one of). 3. (Optional) a true/false indicator if the value should be formatted following the user's culture settings. This is used for numbers and dates. If there are no filters the function will return an Index out of Range message. Indexes begin with 1. Note: The optional 3rd parameter is not recommended for use in computational formulas. For more information about best practices, click here. |
|
Example |
Suppose the filter summary is “Order Detail.UnitPrice > '3.6' and Products.ProductName is one of ('Boston Crab Meat', 'Tofu')”. Ex. FilterValue(2,2) returns Tofu. |
Hyperlink
|
Description |
Creates a hyperlink to an external website. |
|
Remark |
Takes two arguments. 1. The URL of the website. 2. (Optional) the text to display in the cell. If display text is omitted, the URL will display. Note: If PDF exports open in a tab within this application, then clicking the hyperlink may direct a user to leave the application. Note: Cannot be used inside of an If() function. Note: Not currently available in Crosstab reports. |
|
Example |
Ex. Hyperlink(‘www.fakeWebSite.com’, ‘click here’) returns a hyperlink that displays the text ‘click here’ . Clicking this text will open http://www.fakeWebSite.com. |
LoadImage
|
Description |
Loads a server side image based on the input path into the cell. |
|
Remark |
Can be used to load an image dynamically in place of the insert image feature. The path to the image must be in quotation marks. The entire path of the image is not required if your administrator has set a 'LoadImage' Prefix. Can also be used to load images stored in a database by using a data field as the function's argument (without quotes). |
|
Example |
Ex. LoadImage("C:/StarryNight.jpg") Ex. LoadImage({Categories.Picture}) Ex. LoadImage("https://exagoinc.com/wp-content/uploads/2018/02/logo.png") |
StripHTMLTags
|
Description |
Removes any HTML tags from the input string. |
|
Remark |
The input must be a string in between quotation marks. |
|
Example |
Ex. StripHtmlTags("<h1>This is heading 1</h1>") - returns This is heading 1. |
ExcelFormula
|
Description |
Passes an Excel formula to an Excel report. |
|
Remark |
The input must be a string in between quotation marks. Must be the outermost function in a formula. |
|
Example |
Ex. ExcelFormula("SUM(A1:A100)") will pass the formula SUM(A1:A100) to Excel, which will evaluate the formula when the spreadsheet is opened. |
PageNumber
|
Description |
Returns the current page number for HTML, PDF, and RTF Advanced or Express Reports. |
|
Remark |
Equivalent to the @pageNumber@ parameter. Available in version 2017.2 and later. (v2017.3.8+) Also works in Chained Reports. |
|
Example |
Ex. PageNumber() |
ExportType
|
Description |
Returns the format the report is being exported as. |
|
Remark |
This is useful for conditionally suppressing report sections depending on the export type. Available in version 2017.2 and later. |
|
Example |
Ex. ExportType() |