Provides a command for displaying images that are retrieved from a repository or another data source.
Commands of this library may only be used in DOCX document content.
image
Replaces an image within this command's content control with the image that the value attribute resolves to. Not having a placeholder image within the content control causes the command to only produce an error.
Attributes
| value | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| Yes | File, String | Yes |
| Defines the replacement image. If the resolved value is a File, that File is assumed to be an image and will then serve as the replacement image. An error message is produced if the File is not of a known image file format. If the resolved value is a String, the String is treated as an ID of an image file in the user's default repository. For Salesforce users, this String would therefore have to be the ID of a ContentDocument record in their organization. The file found with the ID is then used as the replacement image. | ||
| lockHeight | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | Boolean | Yes |
Defines if the replacement image's height in the document will be that of the placeholder image or its own defined height. Should the resolved value be true, the height of the placeholder is used and the replacement image's width is also adjusted to preserve the replacement image's own aspect ratio. However, should both lockHeight and lockWidth be true, the original aspect ratio is ignored as both dimensions are locked to the placeholder's values. Please note that whenever this command automatically adjusts dimensions to preserve aspect ratio, the calculations are done based on the assumption that the replacement image's resolution is 96 DPI - other resolution values can make the adjusted dimensions smaller or larger than expected. Also note that this attribute conflicts directly with the attribute useReplacementSize, which exists for backwards compatibility reasons. If that attribute's value is defined, this attribute has no effect. | ||
| lockWidth | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | Boolean | Yes |
Defines if the replacement image's width in the document will be that of the placeholder image or its own defined width. Should the resolved value be true, the width of the placeholder is used and the replacement image's height is also adjusted to preserve the replacement image's own aspect ratio. However, should both lockHeight and lockWidth be true, the original aspect ratio is ignored as both dimensions are locked to the placeholder's values. Please note that whenever this command automatically adjusts dimensions to preserve aspect ratio, the calculations are done based on the assumption that the replacement image's resolution is 96 DPI - other resolution values can make the adjusted dimensions smaller or larger than expected. Also note that this attribute conflicts directly with the attribute useReplacementSize, which exists for backwards compatibility reasons. If that attribute's value is defined, this attribute has no effect. | ||
| useReplacementSize |
||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | Boolean | Yes |
Defines if the replacement image will appear in the document in its original size and aspect ratio. Should the resolved value be true, no size modifications are done, but if it is false, the replacement image will be scaled to fill the boundaries of the placeholder image. If undefined, lockHeight and lockWidth may define the dimensions of the replacement image.Please note that this attribute conflicts directly with attributes lockHeight and lockWidth and is only included for backwards compatibility. If this attribute's value is defined, those two attributes have no effect. | ||
| locked | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | Boolean | Yes |
Defines if this command's content control is locked, which prevents it from being deleted. If the resolved value is true, the content control will be locked. | ||
| contentLocked | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | String | Yes |
Defines if this command's content control's contents are locked, which prevents them from being edited. If the resolved value is true, the contents will be locked. | ||
| title | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | String | Yes |
| Defines the title of this command's content control when the Smart Content feature is enabled. In undefined, the title is set to "lock". | ||
| tagLogic | ||
|---|---|---|
|
Required |
Value type |
EL-evaluated |
| No | String | Yes |
| Specifies the tag logic that will be executed right before the evaluation of this command. The resolved String is expected to be the name of a tag controller. | ||
Comments
0 comments