ReportMagic

[Table.Format:]

Formats cells in the previous table (Word).

Purpose

Formats cells in the previous table (Word) or (in PowerPoint) either: the only table on the current slide, or a table/tables by ID on the current slide. A subset of the rows can be formatted using the startRowIndex/endRowIndex parameters. A subset of the columns can be formatted using the startColumnIndex/endColumnIndex parameters.

Compatibility

The macro can be used in all input document types and in Report Studio.

Usage

When the table has more than 10,000 rows, the macro will generate a warning. This macro cannot be used inside a table. In PowerPoint, the macro can be used inside shape text or in the notes field, or in the Alt Text of a shape.

Parameters (44)

Grouped View

Behaviour (5)

Parameter	Type	Presence	Purpose	Options	Default
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
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 theObject, 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
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

Colours (8)

Parameter	Type	Presence	Purpose	Options	Default
backgroundColor	Color	Optional	The background color to set. If provided, do not set backgroundColorOddRows or backgroundColorEvenRows.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
backgroundColorEvenRows	Color	Optional	The background color to set on odd rows. If provided, do not set backgroundColor.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
backgroundColorOddRows	Color	Optional	The background color to set on odd rows. If provided, do not set backgroundColor.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
bottomBorderColor	Color	Optional	The bottom border color to set.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontColor	Color	Optional	The font color to set.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
leftBorderColor	Color	Optional	The left border color to set.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
rightBorderColor	Color	Optional	The right border color to set.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
topBorderColor	Color	Optional	The top border color to set.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Formatting (19)

Parameter	Type	Presence	Purpose	Options	Default
bottomBorderSpace	Int32	Optional	The bottom border space to set. Not applicable to PowerPoint tables.	From 0 to 72	N/A
bottomBorderStyle	String	Optional	The bottom border style to set. In Word, valid border styles are: 'Nil', 'None', 'Single', 'Thick', 'Double', 'Dotted', 'Dashed', 'DotDash', 'DotDotDash', 'Triple', 'ThinThickSmallGap', 'ThickThinSmallGap', 'ThinThickThinSmallGap', 'ThinThickMediumGap', 'ThickThinMediumGap', 'ThinThickThinMediumGap', 'ThinThickLargeGap', 'ThickThinLargeGap', 'ThinThickThinLargeGap', 'Wave', 'DoubleWave', 'DashSmallGap', 'DashDotStroked', 'ThreeDEmboss', 'ThreeDEngrave', 'Outset' or 'Inset'. In PowerPoint, valid border styles are: 'solid', 'dot', 'dash', 'dashDot', 'lgDash', 'lgDashDot', 'lgDashDotDot', 'sysDash', 'sysDot', 'sysDashDot' or 'sysDashDotDot'.	N/A	N/A
bottomBorderWidth	Int32	Optional	The bottom border width to set. In Report Studio this defaults to pixels. In a Schedule (Word), this defaults to points.	From 2 to 96	N/A
columnWidthPercent	Double	Optional	The column width percent to set, as a proportion of the overall table width.	N/A	N/A
font	String	Optional	The font to set.	N/A	N/A
fontBold	Boolean	Optional	Whether to set the font bold.	true false	N/A
fontSize	Double	Optional	The font size to set.	N/A	N/A
horizontalPositionAlignment	String	Optional	The horizontal position alignment to set. Permitted values: Left, Center, Right.	N/A	N/A
leftBorderSpace	Int32	Optional	The left border space to set. Not applicable to PowerPoint tables.	From 0 to 72	N/A
leftBorderStyle	String	Optional	The left border style to set.In Word, valid border styles are: 'Nil', 'None', 'Single', 'Thick', 'Double', 'Dotted', 'Dashed', 'DotDash', 'DotDotDash', 'Triple', 'ThinThickSmallGap', 'ThickThinSmallGap', 'ThinThickThinSmallGap', 'ThinThickMediumGap', 'ThickThinMediumGap', 'ThinThickThinMediumGap', 'ThinThickLargeGap', 'ThickThinLargeGap', 'ThinThickThinLargeGap', 'Wave', 'DoubleWave', 'DashSmallGap', 'DashDotStroked', 'ThreeDEmboss', 'ThreeDEngrave', 'Outset' or 'Inset'. In PowerPoint, valid border styles are: 'solid', 'dot', 'dash', 'dashDot', 'lgDash', 'lgDashDot', 'lgDashDotDot', 'sysDash', 'sysDot', 'sysDashDot' or 'sysDashDotDot'.	N/A	N/A
leftBorderWidth	Int32	Optional	The left border width to set. In Report Studio this defaults to pixels. In a Schedule (Word), this defaults to points.	From 2 to 96	N/A
rightBorderSpace	Int32	Optional	The right border space to set. Not applicable to PowerPoint tables.	From 0 to 72	N/A
rightBorderStyle	String	Optional	The right border style to set.In Word, valid border styles are: 'Nil', 'None', 'Single', 'Thick', 'Double', 'Dotted', 'Dashed', 'DotDash', 'DotDotDash', 'Triple', 'ThinThickSmallGap', 'ThickThinSmallGap', 'ThinThickThinSmallGap', 'ThinThickMediumGap', 'ThickThinMediumGap', 'ThinThickThinMediumGap', 'ThinThickLargeGap', 'ThickThinLargeGap', 'ThinThickThinLargeGap', 'Wave', 'DoubleWave', 'DashSmallGap', 'DashDotStroked', 'ThreeDEmboss', 'ThreeDEngrave', 'Outset' or 'Inset'. In PowerPoint, valid border styles are: 'solid', 'dot', 'dash', 'dashDot', 'lgDash', 'lgDashDot', 'lgDashDotDot', 'sysDash', 'sysDot', 'sysDashDot' or 'sysDashDotDot'.	N/A	N/A
rightBorderWidth	Int32	Optional	The right border width to set. In Report Studio this defaults to pixels. In a Schedule (Word), this defaults to points.	From 2 to 96	N/A
rowHeight	Int32	Optional	The row height to set. This works to the same scale as font width, so try a value of 40 for double-height rows. In Report Studio this defaults to pixels. In a Schedule (Word), this defaults to points.	From 0 to 200	N/A
topBorderSpace	Int32	Optional	The top border space to set. Not applicable to PowerPoint tables.	From 0 to 72	N/A
topBorderStyle	String	Optional	The top border style to set.In Word, valid border styles are: 'Nil', 'None', 'Single', 'Thick', 'Double', 'Dotted', 'Dashed', 'DotDash', 'DotDotDash', 'Triple', 'ThinThickSmallGap', 'ThickThinSmallGap', 'ThinThickThinSmallGap', 'ThinThickMediumGap', 'ThickThinMediumGap', 'ThinThickThinMediumGap', 'ThinThickLargeGap', 'ThickThinLargeGap', 'ThinThickThinLargeGap', 'Wave', 'DoubleWave', 'DashSmallGap', 'DashDotStroked', 'ThreeDEmboss', 'ThreeDEngrave', 'Outset' or 'Inset'. In PowerPoint, valid border styles are: 'solid', 'dot', 'dash', 'dashDot', 'lgDash', 'lgDashDot', 'lgDashDotDot', 'sysDash', 'sysDot', 'sysDashDot' or 'sysDashDotDot'.	N/A	N/A
topBorderWidth	Int32	Optional	The top border width to set. In Report Studio this defaults to pixels. In a Schedule (Word), this defaults to points.	From 2 to 96	N/A
verticalPositionAlignment	String	Optional	The vertical position alignment to set. Permitted values: Top, Center, Bottom.	N/A	N/A

Chart (1)

Parameter	Type	Presence	Purpose	Options	Default
lineWidthUnits	LineWidthUnitsType	Optional	The units to use for line or row widths and heights. In Report Studio this defaults to pixels. In a Schedule (Word), this defaults to points.	Default Points Pixels	Default

Output (2)

Parameter	Type	Presence	Purpose	Options	Default
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
failureVariable	String	Optional	The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message.	N/A	N/A

General (9)

Parameter	Type	Presence	Purpose	Options	Default
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
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: Unknown, Success, MacroError, WorkerStopped, Running, Warning, NeverRun, Cancelled, Pending, Paused, SystemError, Deferred, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
endColumnIndex	Int32	Optional	The column index to end at. If the specified value is higher than the rightmost index, the rightmost index is used. Must be greater than or equal to startColumnIndex.	From 0 to 200	200
endRowIndex	Int32	Optional	The row index to end at. If the specified value is higher than the rightmost index, the rightmost index is used. Must be greater than or equal to startRowIndex.	From 0 to 20000	20000
expectedType	String	Optional	If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type.	N/A	N/A
expectedValue	String	Optional	If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared.	N/A	N/A
ids	List<String>	Optional	For PowerPoint input templates only, the table IDs for which to apply the style. When you have only one table on the slide, this parameter is not required. The table IDs do not need to be unique, i.e. you can have 5 tables all with the ID 'My Tables'. To add an ID to a table in PowerPoint, select the table then click Vew Alt Text... then enter the ID in the edit box that appears.	N/A	N/A
startColumnIndex	Int32	Optional	The column index to start from. The leftmost column index is 0. Must be less than or equal to endColumnIndex.	From 0 to 2147483647	0
startRowIndex	Int32	Optional	The row index to start from. The topmost row index is 0. Must be less than or equal to endRowIndex.	From 0 to 2147483647	0

Examples (5)

Example 1

[Calculate: value=`list(list('Month', 'London', 'Manchester', 'Cardiff', 'Newcastle'), list('October', 1, 2, 3, 4), list('September', 5, 6, 7, 8))`, =>Values][List.Table: values={=Values}][Table.Format: startRowIndex=1, rowHeight=20]

Example 2

[Calculate: value=`list(list('Month', 'London', 'Manchester', 'Cardiff', 'Newcastle'), list('October', 1, 2, 3, 4), list('September', 5, 6, 7, 8))`, =>Values][List.Table: values={=Values}][Table.Format: endRowIndex=0, fontSize=6]

Example 3

[Calculate: value=`list(list('Month', 'London', 'Manchester', 'Cardiff', 'Newcastle'), list('October', 1, 2, 3, 4), list('September', 5, 6, 7, 8))`, =>Values][List.Table: values={=Values}][Table.Format: startColumnIndex=1, horizontalPositionAlignment=Center, columnWidthPercent=8.5]

Example 4

[Calculate: value=`list(list('Month', 'London', 'Manchester', 'Cardiff', 'Newcastle'), list('October', 1, 2, 3, 4), list('September', 5, 6, 7, 8))`, =>Values][List.Table: values={=Values}][Table.Format: endColumnIndex=0, horizontalPositionAlignment=Left, columnWidthPercent=15]

Example 5

[Calculate: value=`list(list('Month', 'London', 'Manchester', 'Cardiff', 'Newcastle'), list('October', 1, 2, 3, 4), list('September', 5, 6, 7, 8))`, =>Values][List.Table: values={=Values}][Table.Format: endColumnIndex=0, endRowIndex=0, backgroundColor=White, fontColor=White]