---

Purpose

Use the [Table.Sort:] macro to sort the previous table in the document by the specified column index (i.e. the column number from left to right starting at 1). The macro assumes a header row which it ignores.

---

Macro Compatibility

---

Usage

When the table has more than 10,000 rows, the macro will generate a warning.

---

Parameter	Type	Presence	Purpose	Options	Default
orderBy	List<String>	Mandatory	The semicolon-separated columns to order by in the form '<columnIndex>^<numeric|alphanumeric|auto (default)>^<asc (default)|desc>'. Use 'asc' for ascending alphanumeric order or 'desc' for descending alphanumeric order. Between one and three columns may be specified.	N/A	N/A
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
ignoreHeaderRow	Boolean	Optional	Whether to ignore the header (first) row.	true false	true
ignoreLastRow	Boolean	Optional	Whether to ignore the last row (e.g. for a 'totals' row).	true false	false
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
skip	Int32	Optional	Skip over (ignore) the first X number of rows in the table. The header row is unaffected unless ignoreHeaderRow is false (in that case it's treated as a normal row).	From 0 to 2147483647	N/A
take	Int32	Optional	Use only the first X number of rows in the table. The header row is unaffected unless ignoreHeaderRow is false (in that case it's treated as a normal row).	From 0 to 2147483647	N/A
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A

---

Examples (3)

Example 1:

[Table.Sort:orderBy=1^^]

---

Example 2:

[Table.Sort:orderBy=4^numeric^asc;3^alphanumeric^desc]

---

Example 3:

Skip the first 10 rows, then take the following 10 rows only:

[Table.Sort:orderBy=1^alphanumeric^desc,skip=10,take=10]