BackgroundPictureH Property, SftTree Object
Defines the graphic displayed as the control's background.
Syntax
Get
| VB.NET | Handle = object.BackgroundPictureH As Integer |
| VB | Handle = object.BackgroundPictureH As OLE_HANDLE |
| C#.NET | int Handle = object.BackgroundPictureH; |
| VC++ | OLE_HANDLE Handle = object->BackgroundPictureH;
OLE_HANDLE Handle = object->GetBackgroundPictureH(); |
| C | HRESULT object->get_BackgroundPictureH(OLE_HANDLE* Handle); |
Put
| VB.NET | object.BackgroundPictureH = Handle As Integer |
| VB | object.BackgroundPictureH = Handle As OLE_HANDLE |
| C#.NET | int object.BackgroundPictureH = Handle; |
| VC++ | OLE_HANDLE object->BackgroundPictureH = Handle;
void object->PutBackgroundPictureH(OLE_HANDLE Handle); |
| C | HRESULT object->put_BackgroundPictureH(OLE_HANDLE Handle); |
object
A SftTree object.
Handle
A bitmap handle. This bitmap contains the graphic used as the control's background. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed.
Comments
The BackgroundPictureH property defines the graphic displayed as the control's background.
The BackgroundPicture and BackgroundPictureH properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).
If the Background property defines a valid bitmap, this bitmap is displayed as the tree control's background. If the background bitmap is too small to fill the entire client area of the tree control, it is tiled. The properties BackgroundX and BackgroundY can be used to define an offset with which the bitmap should be aligned. The background bitmap is aligned with the top, left edge of the tree control window (not the client area) if 0 is specified.
The BackgroundStyle property defines whether the bitmap is centered or should be scrolled horizontally when the tree control contents are scrolled horizontally.
The row header area, area and column header do not display the background bitmap. These areas are not transparent.
There is no default background bitmap. Bitmap transparency is not used for the background bitmap.
If a background bitmap is used, the background colors defined for the tree control, columns and cells should be set to the default values, so these do not interfere with the background bitmap.
When using RightToLeft for right-to-left reading support, the bitmap origin is the top, right corner of the tree control window. The properties BackgroundX and BackgroundY specify offsets relative to the top, right edge of the tree control window. In this case, the bitmap is also tiled right to left.
See Also SftTree Object | Object Hierarchy
On
Off