com.esri.arcgis.geoprocessing
Interface IGPToolExtensionFactory

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGPToolExtensionFactoryProxy

public interface IGPToolExtensionFactory
extends Serializable

Provides access to methods on a geoprocessing tool extension factory object.

Product Availability

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


Method Summary
 boolean canEdit()
          Returns whether or not the factory supports editing instances of the tool extension.
 IGPToolExtension create(int parent, IGPToolbox destination, String[] defaultName, String[] defaultDisplayName, String[] defaultDescription)
          Creates a new instance of a tool extension in the given toolbox.
 void edit(int parent, IGPToolExtension toolExtension)
          Invokes a window to edit a tool extension.
 IUID getCLSID()
          The CLSID of the tool extension factory class.
 int getLargeImage()
          A 32x32 bitmap to associate with the tool extension.
 int getLargeInvalidImage()
          A 32x32 bitmap to associate with invalid instances of the tool extension.
 int getLargeUnlicensedImage()
          A 32x32 bitmap to associate with unlicensed instances of the tool extension.
 int getSmallImage()
          A 16x16 bitmap to associate with the tool extension.
 int getSmallInvalidImage()
          A 16x16 bitmap to associate with invalid instances of the tool extension.
 int getSmallUnlicensedImage()
          A 16x16 bitmap to associate with unlicensed instances of the tool extension.
 String getToolExtensionName()
          Name of the tool extension factory class.
 void postCreateTool(int parent, IGPToolExtension toolExtension)
          Called immediately following the creation of a new tool extension.
 

Method Detail

getCLSID

IUID getCLSID()
              throws IOException,
                     AutomationException
The CLSID of the tool extension factory class.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolExtensionName

String getToolExtensionName()
                            throws IOException,
                                   AutomationException
Name of the tool extension factory class.

Product Availability

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

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

getSmallImage

int getSmallImage()
                  throws IOException,
                         AutomationException
A 16x16 bitmap to associate with the tool extension.

Product Availability

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

Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

int getLargeImage()
                  throws IOException,
                         AutomationException
A 32x32 bitmap to associate with the tool extension.

Product Availability

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

Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallInvalidImage

int getSmallInvalidImage()
                         throws IOException,
                                AutomationException
A 16x16 bitmap to associate with invalid instances of the tool extension.

Product Availability

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

Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeInvalidImage

int getLargeInvalidImage()
                         throws IOException,
                                AutomationException
A 32x32 bitmap to associate with invalid instances of the tool extension.

Product Availability

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

Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallUnlicensedImage

int getSmallUnlicensedImage()
                            throws IOException,
                                   AutomationException
A 16x16 bitmap to associate with unlicensed instances of the tool extension.

Product Availability

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

Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeUnlicensedImage

int getLargeUnlicensedImage()
                            throws IOException,
                                   AutomationException
A 32x32 bitmap to associate with unlicensed instances of the tool extension.

Product Availability

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

Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

IGPToolExtension create(int parent,
                        IGPToolbox destination,
                        String[] defaultName,
                        String[] defaultDisplayName,
                        String[] defaultDescription)
                        throws IOException,
                               AutomationException
Creates a new instance of a tool extension in the given toolbox.

Product Availability

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

Parameters:
parent - The parent (A COM typedef) (in)
destination - A reference to a com.esri.arcgis.geoprocessing.IGPToolbox (in)
defaultName - The defaultName (out: use single element array)
defaultDisplayName - The defaultDisplayName (out: use single element array)
defaultDescription - The defaultDescription (out: use single element array)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCreateTool

void postCreateTool(int parent,
                    IGPToolExtension toolExtension)
                    throws IOException,
                           AutomationException
Called immediately following the creation of a new tool extension.

Product Availability

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

Parameters:
parent - The parent (A COM typedef) (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canEdit

boolean canEdit()
                throws IOException,
                       AutomationException
Returns whether or not the factory supports editing instances of the tool extension.

Product Availability

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

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

edit

void edit(int parent,
          IGPToolExtension toolExtension)
          throws IOException,
                 AutomationException
Invokes a window to edit a tool extension.

Product Availability

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

Parameters:
parent - The parent (A COM typedef) (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.