ImageScale Property

Summary

Optional scale value to use when rendering the images of this item.

Syntax

C++

public virtual double ImageScale { get; set; }

Public Overridable Property ImageScale() As Double 
   Get 
   Set

public:  
   virtual property double ImageScale 
   { 
      double get() 
      void set(double value) 
   }

Property Value

The optional scale value to use when rendering the images of this item. Default value is 1.

Remarks

ImageScale is used when an item with an image or a URL to an image is added to the ImageViewer. The ImageSize property is automatically obtained from the image object. If the value of ImageScale is not 1 (the default), then ImageSize will be multiplied by this value. This allows the user to use a smaller image in the item to save system resources but still with ImageScale set to the ratio between the original image size and the smaller version, the viewer will update ImageSize accordingly.

ImageScale property of ImageViewer will update this member if this is the active item when the viewer is used in single item mode.

For more information, refer to Image Viewer Items.

Requirements

Target Platforms