Image Property (TemplateImage)

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property Image As Image

'Usage
 
Dim instance As TemplateImage
Dim value As Image
 
instance.Image = value
 
value = instance.Image

public Image Image {get; set;}

public:
property Image^ Image {
   Image^ get();
   void set (    Image^ value);
}

This property provides a way for you to read and write the template image. This property accepts and returns .NET Image objects. Similar properties of this object accept and return the same image in other forms.

Important Information for Memory Management

If you set the template image using this property, this object will create a copy of your image and not keep a reference to your image.
If you get the template image using this property, this object will return a copy of the underlying image it holds and not keep a reference to the image that it returns. When you are finished with an image that this property returns, you must dispose of it properly using the System.IDisposable.Dispose method.

Template images must always be 1 bit-per-pixel. Gray or color images are not acceptable.

Changing this property will cause the HasChanged property to change to true.

Valid values: Any 1 bit-per-pixel image.

Default value: null

Reference

TemplateImage Class
TemplateImage Members
CompressedData Property
Hbitmap Property
Hdib Property