com.esri.arcgis.systemUI
Interface ICompletionNotify

All Superinterfaces:
Serializable
All Known Implementing Classes:
ICompletionNotifyProxy

public interface ICompletionNotify
extends Serializable

Provides access to a method that advises the framework that the control user has indicated completion.

Remarks

When a ToolControl object gains focus, an ICompletionNotify object is passed to the ToolControl in the IToolControl::OnFocus method.

When To Use

The ICompletionNotify interface provides the IToolControl interface a mechanism to report to the application that the ToolControl no longer needs focus.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IToolControl.onFocus(com.esri.arcgis.systemUI.ICompletionNotify)

Method Summary
 void setComplete()
          Advises the framework that the control user has indicated completion.
 

Method Detail

setComplete

void setComplete()
                 throws IOException,
                        AutomationException
Advises the framework that the control user has indicated completion.

Remarks

When a ToolControl object gains focus, an ICompletionNotify object is passed to the ToolControl in the IToolControl::OnFocus method. The ToolControl needs to call the SetComplete method when it's finished to let the application know that the control should lose focus.

For example, a combobox control should lose focus after a user selects an item in the combobox. In this case in you would call SetComplete in the Click event of the combobox control.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.