Difference between revisions of "Inline Expressions"
| Line 33: | Line 33: | ||
This is a very special inline expression and can only be used inside the <code>data</code> property of a template object. It is used to reference properties of a templated item. The <code>{PROPERTY}</code> part must be replaced with any property that is available in the templated item (e.g. if the item has a property <code>"customProperty": "customValue"</code>, it can be referenced with <code>"{context:customProperty}"</code> → <code>"customValue"</code>). The referenced property must exist (either in the templated item or in the template object), otherwise the expression can not be replaced and will remain as it is (e.g. <code>"{context:missingProperty}"</code> → <code>"{context:missingProperty}"</code>). Additionally, the value of the referenced property must be indicated as string, otherwise the expression is removed (e.g. <code>"{context:invalidProperty}"</code> → <code>""</code>). | This is a very special inline expression and can only be used inside the <code>data</code> property of a template object. It is used to reference properties of a templated item. The <code>{PROPERTY}</code> part must be replaced with any property that is available in the templated item (e.g. if the item has a property <code>"customProperty": "customValue"</code>, it can be referenced with <code>"{context:customProperty}"</code> → <code>"customValue"</code>). The referenced property must exist (either in the templated item or in the template object), otherwise the expression can not be replaced and will remain as it is (e.g. <code>"{context:missingProperty}"</code> → <code>"{context:missingProperty}"</code>). Additionally, the value of the referenced property must be indicated as string, otherwise the expression is removed (e.g. <code>"{context:invalidProperty}"</code> → <code>""</code>). | ||
| − | '''Note: Please note that the referenced property should not contain escaped double quotes <code> | + | '''Note: Please note that the referenced property should not contain escaped double quotes <code>\"</code> or line breaks <code>\n</code>, but the equivalent inline expressions <code>{chr:quot}</code> and <code>{br}</code>. Since version 0.1.110, also the <code>properties</code>, <code>live</code>, <code>selection</code>, and <code>options</code> property of a template object supports this inline expression.''' |
|- | |- | ||
| <code>{unknown}</code> || <code>{unknown}</code> || data-sort-value=0|0.1.0 || | | <code>{unknown}</code> || <code>{unknown}</code> || data-sort-value=0|0.1.0 || | ||
Revision as of 12:21, 25 May 2022
Most of the text properties support inline expressions for adding icons or coloring text parts. Each expression starts with character { and ends with character }. Nested expressions are not supported.
| Expression | Example | Since Version | Description |
|---|---|---|---|
{sp} |
{sp} |
0.1.0 |
Non-breakable space. |
{tb} |
{tb} |
0.1.0 |
Non-breakable tab. |
{br} |
{br} |
0.1.0 |
Line break. |
{ico:{ICON}} |
{ico:home} |
0.1.0 |
Icon. The |
{ico:{COLOR}:{ICON}} |
{ico:msx-red:home} |
0.1.0 |
Colored icon. The |
{txt:{COLOR}:{TEXT}} |
{txt:msx-red:Hello there!} |
0.1.0 |
Colored text. The |
{chr:{CHARACTER}} |
{chr:copy}{chr:#169} |
0.1.145 |
Character entity. The |
{chr:{COLOR}:{CHARACTER}} |
{chr:msx-red:copy}{chr:msx-red:#169} |
0.1.145 |
Colored character entity. The |
{context:{PROPERTY}} |
{context:label} |
0.1.0 |
This is a very special inline expression and can only be used inside the Note: Please note that the referenced property should not contain escaped double quotes |
{unknown} |
{unknown} |
0.1.0 |
Any unknown expression is returned as it is without the braces (e.g. |