[InsertTableCellImage:]
Inserts an image as the background of the current table cell.
Macro Compatibility
The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.
Usage
NOTE: this macro is currently only supported in PowerPoint. You can achieve a similar result to set a table cell's background image in PowerPoint using the [Shape.Format:] macro.
Parameter | Type | Presence | Purpose | Options | Default |
---|---|---|---|---|---|
String | Conditional | The picture file name. When set, do not specify 'pictureVariable'. | N/A | N/A | |
String | Conditional | The name of the variable that holds the picture to use for the table cell background image. Macros that produce graphs can store the data using the 'storeAsHidden' parameter. When set, do not specify 'pictureFilename'. | N/A | N/A | |
String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
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 | |
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 | |
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 |
|
Legacy | |
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 | |
Int32 | Optional | The offset bottom percentage. Must be a value between -100,000 and 100,000 inclusive. | N/A | N/A | |
Int32 | Optional | The offset left percentage. Must be a value between -100,000 and 100,000 inclusive. | N/A | N/A | |
Int32 | Optional | The offset right percentage. Must be a value between -100,000 and 100,000 inclusive. | N/A | N/A | |
Int32 | Optional | The offset top percentage. Must be a value between -100,000 and 100,000 inclusive. | N/A | N/A | |
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:
This example sets the table cell's background image from a file in the same input folder.
[InsertTableCellImage: pictureFilename=Picture.png]
Example 2:
This example sets the table cell's background image from a file and also sets the offset percentages (just as can be done in the PowerPoint application):
[InsertTableCellImage: pictureFilename=Picture.png, offsetBottom=10, offsetLeft=20, offsetRight=20, offsetTop=10]
Example 3:
This example sets the table cell's background image from a previously-stored variable. To run this example, ensure you have put the [InsertTableCellImage:] macro into a table cell in the input document:
// Generate an image and store into a variable [List.Graph: values=Value^80.71;Free^19.29;Fill^100, chartTypes=Doughnut, chartWidth=700, chartHeight=700, chartAreaWidthPercent=100, chartAreaHeightPercent=100, legendWidthPercent=0, xValueType=String, palette=Value^#ED7411;Free^LightGray;Fill^White, doughnutRadius=40, pieStartAngleDegrees=180, pageWidthPercent=20, pieLabelStyle=Disabled, writeToSpreadsheet=false, =>Image] // Set the table cell background image [InsertTableCellImage: pictureVariable=Image]