SftMask/OCX 7.0 - ActiveX Masked Edit Control

MouseIcon Property, SftMask Object

Defines a custom mouse icon.

Syntax

Get

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

Put

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

PutRef

VB.NET	object.MouseIcon = refPictureObj As System.Drawing.Image
VB	Set object.MouseIcon = refPictureObj As IPictureDisp
C#.NET	System.Drawing.Image object.MouseIcon = refPictureObj;
VC++	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

VB6

Private Sub Form_Load()
    ' A picture box is used to hold the icon for the MouseIcon property. A suitable
    ' icon has been defined in the picture box using its Picture property.
    Set SftMask1.MouseIcon = Picture1.Picture
    SftMask1.MousePointer = sftCustom
    ' Or use a predefined icon
    SftMask1.MousePointer = sftCross
End Sub

View Entire Sample Code

C++

    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;
}

View Entire Sample Code

See Also SftMask Object | Object Hierarchy