MouseIcon Property, SftMask Object

Defines a custom mouse icon.

Syntax

Get

C#	System.Drawing.Image refPictureObj = object.MouseIcon;
VB.NET	refPictureObj = object.MouseIcon As System.Drawing.Image
C++	IPictureDisp* refPictureObj = object->GetMouseIcon();
C	HRESULT object->get_MouseIcon(IPictureDisp** refPictureObj);

Put

C#	void object.let_MouseIcon(System.Drawing.Image refPictureObj);
VB.NET	object.let_MouseIcon(ByVal refPictureObj As System.Drawing.Image)
C++	void object->PutMouseIcon(IPictureDisp* refPictureObj);
C	HRESULT object->put_MouseIcon(IPictureDisp* refPictureObj);

PutRef

C#	System.Drawing.Image object.MouseIcon = refPictureObj;
VB.NET	object.MouseIcon = refPictureObj As System.Drawing.Image
C++	void object->PutRefMouseIcon(IPictureDisp* refPictureObj);
C	HRESULT object->putref_MouseIcon(IPictureDisp* refPictureObj);

object

A SftMask object.

refPictureObj

Defines a custom mouse icon.

Comments

The MouseIcon property defines a custom mouse icon.

The MouseIcon 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.

Using PutRef (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using Put instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of Put, PutRef is the preferred method.

Examples

C++ View entire sample code

    PICTDESC PictDesc;
    PictDesc.cbSizeofstruct = sizeof(PICTDESC);
    PictDesc.picType = PICTYPE_ICON;
    PictDesc.icon.hicon = LoadIcon(NULL, MAKEINTRESOURCE(IDI_WINLOGO));
    IPictureDispPtr pIPictureDisp;
    HRESULT hr = OleCreatePictureIndirect(&PictDesc, IID_IPictureDisp, TRUE, (void**)&pIPictureDisp);
    ASSERT(SUCCEEDED(hr));
    m_pMask1->PutRefMouseIcon(pIPictureDisp);
    m_pMask1->MousePointer = sftCustom;

    // Or use a predefined icon
    m_pMask1->MousePointer = sftCross;

    return TRUE;
}

See Also SftMask Object | Object Hierarchy