com.esri.arcgis.systemUI
Interface IMultiItemEx

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMultiItemExProxy

public interface IMultiItemEx
extends Serializable

Provides access to members that define a multiItem with extended features.

Description

The IMultiItemEx interface provides additional properties for custom MultiItems. You would implement the IMultiItem interface to create a custom multiItem. Additionally, you can implement the IMultItemEx interface if you wanted to assign separate meassages, help files, and help context ids to each item in the multItem.

Product Availability

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

Method Summary

int	getItemHelpContextID(int index) The help context ID associated with the item specified by the index.
String	getItemHelpFile(int index) The name of the help file associated with the item specified by the index.
String	getItemMessage(int index) The status bar message for the item specified by the index.

Method Detail

getItemMessage

String getItemMessage(int index)
                      throws IOException,
                             AutomationException

The status bar message for the item specified by the index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemHelpFile

String getItemHelpFile(int index)
                       throws IOException,
                              AutomationException

The name of the help file associated with the item specified by the index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemHelpContextID

int getItemHelpContextID(int index)
                         throws IOException,
                                AutomationException

The help context ID associated with the item specified by the index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.