ArcObjects Library Reference (Controls)

IPageLayoutControl.MouseIcon Property

Custom mouse icon used if MousePointer is 99.

[Visual Basic .NET]
Public Property MouseIcon As stdole.IPictureDisp

[C#]
public stdole.IPictureDisp MouseIcon {get; set;}

[C++]
HRESULT get_MouseIcon(
  IPictureDisp** ppMouseIcon
);

[C++]
HRESULT putref_MouseIcon(
  IPictureDisp* ppMouseIcon
);

[C++]
Parameters
ppMouseIcon [out, retval]
  ppMouseIcon is a parameter of type IPictureDisp
ppMouseIcon [in]
  ppMouseIcon is a parameter of type IPictureDisp

Product Availability

Available with ArcGIS Engine.

Description

The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).

Remarks

In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.

To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.

[C#]

When working directly with AxControls class use the MouseIcon property as follows:

axPageLayoutControl1.MouseIcon = new Icon("myIcon.ico");
axPageLayoutControl1.MousePointer = esriControlsMousePointer.esriPointerCustom;

When using the Controls interop assembly use the MouseIcon property as follows:

IPageLayoutControl pageLayoutControl = (IPageLayoutControl) axPageLayoutControl1.Object;
Icon icon = new Icon(GetType().Assembly.GetManifestResourceStream(GetType(), "myIcon.ico"));
pageLayoutControl.MouseIcon = (stdole.IPictureDisp) ESRI.ArcGIS.ADF.COMSupport.OLE.GetIPictureDispFromIcon(icon);
pageLayoutControl.MousePointer = esriControlsMousePointer.esriPointerCustom;

[Visual Basic .NET]