BackImage Property

Summary

Optional background image associated with this item.

Syntax

C++

public RasterImage BackImage { get; set; }

Public Property BackImage() As RasterImage 
   Get 
   Set

public:  
   property RasterImage^ BackImage 
   { 
      RasterImage^ get() 
      void set(RasterImage^ value) 
   }

Property Value

The optional background image associated with this item. Default value is null.

Remarks

The background image is optional and does not affect the size or resolution of the item. The viewer will check this value during the rendering cycle, and if a background image is found, it will be rendered during RenderItem just before the main image of the item (if any).

When setting BackImage to a new value, the previous image will be automatically disposed if the value of AutoDisposeImages is set to true. Note that setting the same RasterImage object into multiple items in the same viewer is supported, and the viewer will only dispose the image if it is the last reference found in all the items. When setting the same RasterImage into items from separate viewers, the ownership and disposing of the RasterImage objects must be handled by the user.

Changing the value of this property will fire the ItemChanged event with ImageViewerItemChangedReason.BackImage.

BackImage 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