com.esri.arcgis.systemUI
Class IComponentTipProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.systemUI.IComponentTipProxy

All Implemented Interfaces:

IComponentTip, Externalizable, Serializable

public class IComponentTipProxy
extends com.esri.arcgis.interop.Dispatch
implements IComponentTip, Serializable

Provides a tip for a component that is displayed by the What's This Help tool.

Description

Provides context-sensitive help for a control. Context-sensitive help can be shown using "What's This?" Help tool in the Standard toolbar on ArcGIS for Desktop and then click the command or button.

When To Use

Use this interface to provide context-sensitive help information for your control including button, tool, combo box and multi-item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.systemUI.IComponentTip

IID, IIDfd86ed38_01c7_4a41_a72c_5502031aa216, xxDummy

Constructor Summary

	IComponentTipProxy()
	IComponentTipProxy(Object obj)
protected	IComponentTipProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getHeading() Heading for Tip.
int	getImage() The image for the Tip.
String	getTip() The body of text of the tip.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IComponentTipProxy

public IComponentTipProxy()

IComponentTipProxy

public IComponentTipProxy(Object obj)
                   throws IOException

Throws:

IOException

IComponentTipProxy

protected IComponentTipProxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getHeading

public String getHeading()
                  throws IOException,
                         AutomationException

Heading for Tip.

Specified by:

getHeading in interface IComponentTip

Returns:

The heading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTip

public String getTip()
              throws IOException,
                     AutomationException

The body of text of the tip.

Specified by:

getTip in interface IComponentTip

Returns:

The tip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImage

public int getImage()
             throws IOException,
                    AutomationException

The image for the Tip.

Specified by:

getImage in interface IComponentTip

Returns:

The image (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.