Return to doc.sitecore.com

Documentation

 

1.  Description

The Image XSL rendering is a visual control used for displaying images that are stored in the Sitecore content tree.  

Please refer to the XSL section for more information about creating XSL renderings.

 

2.  Installation Guide

The XSL Image rendering is distributed as a standard Sitecore package; hence in order to start using it, you should install the package. Please refer to the 'Installing Modules and Packages' article if you are not familiar with the standard Sitecore Packager tool.  

After the package installation, you will see the XSL Image rendering in the list of XSL renderings.  

Thus you will be able to place it on a (sub)layout or tie via placeholder like any usual rendering. 

Please note that caching is not set by default.

 

3.  User Manual

The Image is an XSL rendering, thus you can work with it like with any other XSL rendering.

The Image XSL rendering is adjusted via several parameters.   

Open the Parameters tab of the rendering (double-click on the rendering) and set properties as described in the example below.   

 

 

You can also define the properties in the Image rendering (see <!--parameter --> section in the rendering’s source code).

 

Valid Parameters:

 

Alt

Property value:

An alternative text for the image.

Note:

If the Alt property value is not set explicitly, the alt value set for the image in the Media Library is used.

 

HSpace

Property value:

Horizontal spacing.

Note:

If the HSpace property value is not set explicitly, the horizontal spacing value set for the image in the Media Library is used.

 

ImageField

Property value:

Name of the field containing the image.

Note:

The type of the field whose name is specified as a value for the ImageField property should be "image", otherwise the image won’t be shown.

 

Link

Property value:

The true value indicates that the image should link to something (in the resulting HTML, the <img/> tag should be nested in the <a><a/> tag).

Note:

The value is not case sensitive. The default value is false.

 

LinkUrl

Property value:

Specific URL to link to.

Note:

The value of this property is ignored when the Link property value is false.

 

NewWindow

Property value:

The true value indicates that the link should be open in a new Window. The default value is false.

Note:

The value of this property is ignored when the Link property value is false.

 

VSpace

Property value:

Vertical spacing.

Note:

When the VSpace property value is not set explicitly, vertical spacing set for the image in the Media Library is used.

 

Width

Property value:

Image width.

Note:

When the Width property value is not set explicitly, the width set for the image in the Media Library is used.

 

Height

Property value:

The height of the image.

Note:

When the Height property value is not set explicitly, the height set for the image in the Media Library is used.

 

Border

Property value:

Border width  

Note:

When the Border property value is not set explicitly, the border set for the image in the Media Library is used.