AutoDisposeImages Property (RasterThumbnailBrowser)

[CategoryAttribute("Behavior")]
[DescriptionAttribute("Automatically disposes the item images when them item is removed from the control or when the control is disposed.")]
public bool AutoDisposeImages {get; set;}

'Declaration
 
<CategoryAttribute("Behavior")>
<DescriptionAttribute("Automatically disposes the item images when them item is removed from the control or when the control is disposed.")>
Public Property AutoDisposeImages As Boolean

'Usage
 
Dim instance As RasterThumbnailBrowser
Dim value As Boolean
 
instance.AutoDisposeImages = value
 
value = instance.AutoDisposeImages

[CategoryAttribute("Behavior")]
[DescriptionAttribute("Automatically disposes the item images when them item is removed from the control or when the control is disposed.")]
public bool AutoDisposeImages {get; set;}

CategoryAttribute("Behavior")
DescriptionAttribute("Automatically disposes the item images when them item is removed from the control or when the control is disposed.")
 get_AutoDisposeImages();
 set_AutoDisposeImages(value);  

[CategoryAttribute("Behavior")]
[DescriptionAttribute("Automatically disposes the item images when them item is removed from the control or when the control is disposed.")]
public:
property bool AutoDisposeImages {
   bool get();
   void set (    bool value);
}

Property Value

When the value of the AutoDisposeImages is set to true, the RasterImageList control will automatically call the RasterImage.Dispose method on an item's RasterImageListItem.Image when the item is removed from the Items collection or when the control itself is disposed.

The control will check if an image is used with multiple items (for example, if multiple items are using the same image but to show different pages). In this case, the control will correctly dispose the image only once.

If you setup the items with images that you do not want to dispose of and are going to re-use somewhere else, you need to set the value of the AutoDisposeImages property of the RasterImageList control to false.

You can also temporarily change the value of the AutoDisposeImages property if you want to save the item image before you dispose it. For example, set the AutoDisposeImages property to false, call Remove on the Items collection to remove the item, then re-set the AutoDisposeImages property back to true.

Note that if you set the AutoDisposeImages value to false and you do not dispose the item images yourself, the .NET garbage collector will eventually detect that these images are not used anymore and will dispose them for you when the control and any other reference to these images are no longer used in your application.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterThumbnailBrowser Class
RasterThumbnailBrowser Members