HeaderPane
Main
Hide
Share Link
Print

MouseIconH Property, SftButton Object

Defines a custom mouse icon.

Syntax

Get

C#int Handle = object.MouseIconH;
VB.NETHandle = object.MouseIconH As Integer
C++OLE_HANDLE Handle = object->MouseIconH;
OLE_HANDLE Handle = object->GetMouseIconH();
CHRESULT object->get_MouseIconH(OLE_HANDLE* Handle);
VBHandle = object.MouseIconH As OLE_HANDLE

Put

C#int object.MouseIconH = Handle;
VB.NETobject.MouseIconH = Handle As Integer
C++OLE_HANDLE object->MouseIconH = Handle;
void object->PutMouseIconH(OLE_HANDLE Handle);
CHRESULT object->put_MouseIconH(OLE_HANDLE Handle);
VBobject.MouseIconH = Handle As OLE_HANDLE

object

A SftButton object.

Handle

An icon handle. Defines a custom mouse icon. This icon handle has to remain valid until the tree control no longer uses it.

Comments

The MouseIconH property defines a custom mouse icon.

The MouseIconH property provides a custom icon that is used when the MousePointer property is set to sftCustom (99). This mouse pointer is displayed when the cursor is located anywhere on the control.

The MouseIcon and MouseIconH properties are synonyms, but accept different value types (Picture object reference or Windows icon handle).

Even though the class wrapper generated by Visual Studio for .NET applications (C#, VB.NET) includes the MouseIcon property, it is not usable as the System.Drawing.Image type does not support icons. For managed .NET applications the MouseIconH property must be used instead by assigning an icon's handle to the MouseIconH property as in:

axSftButton1.MouseIconH = (int)icon1.Handle;

See Also SftButton Object | Object Hierarchy


Last Updated 11/03/2026 - (email)
© 2026 Softel vdm, Inc.