com.esri.arcgis.geoprocessing
Interface IDEToolbox2

All Superinterfaces:

IDEToolbox, java.io.Serializable

All Known Implementing Classes:

DEToolbox, IDEToolbox2Proxy

public interface IDEToolbox2
extends IDEToolbox, java.io.Serializable

COM Interface 'IDEToolbox2'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to properties/methods of a toolbox data element object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDa6bfa57e_e24f_4488_b12b_0039e32e7c3e
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.geoprocessing.IDEToolbox

IID13898bab_baf8_438c_ae88_cc3f3341b270

Method Summary

java.lang.String	getDisplayName() The display name of the toolbox.
int	getHelpContext() The context identifier of the topic within the help file for this toolbox.
java.lang.String	getHelpFile() The name of the (CHM) file containing help information for this toolbox.
void	setDisplayName(java.lang.String displayName) The display name of the toolbox.
void	setHelpContext(int context) The context identifier of the topic within the help file for this toolbox.
void	setHelpFile(java.lang.String file) The name of the (CHM) file containing help information for this toolbox.

Methods inherited from interface com.esri.arcgis.geoprocessing.IDEToolbox

getAlias, setAlias

Field Detail

IIDa6bfa57e_e24f_4488_b12b_0039e32e7c3e

static final int IIDa6bfa57e_e24f_4488_b12b_0039e32e7c3e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getDisplayName

java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The display name of the toolbox.

Returns:

The displayName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(java.lang.String displayName)
                    throws java.io.IOException,
                           AutomationException

The display name of the toolbox.

Parameters:

displayName - The displayName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

The name of the (CHM) file containing help information for this toolbox.

Returns:

The file

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpFile

void setHelpFile(java.lang.String file)
                 throws java.io.IOException,
                        AutomationException

The name of the (CHM) file containing help information for this toolbox.

Parameters:

file - The file (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContext

int getHelpContext()
                   throws java.io.IOException,
                          AutomationException

The context identifier of the topic within the help file for this toolbox.

Returns:

The context

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpContext

void setHelpContext(int context)
                    throws java.io.IOException,
                           AutomationException

The context identifier of the topic within the help file for this toolbox.

Parameters:

context - The context (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.