Hbitmap Property

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property Hbitmap As IntPtr

'Usage
 
Dim instance As TemplateImage
Dim value As IntPtr
 
instance.Hbitmap = value
 
value = instance.Hbitmap

public IntPtr Hbitmap {get; set;}

public:
property IntPtr Hbitmap {
   IntPtr get();
   void set (    IntPtr value);
}

This property provides a way for you to read and write the template image. This property accepts and returns WIN32 HBITMAP handles. 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 call the WIN32 DeleteObject() function to release it.

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.

Note: The HBITMAP is an object of the device context and does not have a defined resolution. Because of this, and the fact that FormFix requires a resolution to perform form identification, HBITMAP's should not be used to transfer images between the FormDirector and FormFix components. Instead, the use of HDIB's are encouraged as the fastest method for transferring images between FormDirector, ImagXpress, and FormFix components.

Valid values: Any HBITMAP that contains a 1 bit-per-pixel image.

Default value: 0

Reference

TemplateImage Class
TemplateImage Members
CompressedData Property
Image Property
Hdib Property