com.esri.arcgis.addinframework
Interface IAddInManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

IAddInManagerProxy

public interface IAddInManager
extends Serializable

IAddInManager Interface

Method Summary

void	addFolder(String pathToAddInFolder) Adds a path to the folder processing list.
void	createObject(GUID addInID, Object pOuter, Object[] ppObj) Create an instance of the specified object.
IEnumAddInFolders	getAddInFolders() Retrieves add-in probing folders.
IEnumNode	getAddInRecords() Retrieves all registered addin records.
IEnumNode	getAddInRecordsEx(String xpathQuery) Retrieves registered addin records matching the specified xpath query.
int	getEnabled() Indicates if the addin manager is enabled.
void	getIDsInCategory(GUID category, IEnumAddInID[] ppEnumAddInIDs) Enumerate objects IDs within a specified category.
void	getLocale(String[] locale) Retrives the current locale.
IAddInRecord	getRecord(GUID addInID) Returns the record asociated with the specified ID.
void	initialize(Object pHook, String langID) Called to initialize the addin manager (normally called at application startup).
void	initializeEx(Object pHook, String langID, int options) Called to initialize the addin manager (normally called at application startup).
boolean	isUserMode() Indicates if the add-in manager is in user mode.
void	refresh(String pathToAddInFolder) Refreshes AddIns information in the specified folder.
void	removeFolder(String pathToAddInFolder) Removes a path from the folder processing list.
void	setEnabled(int enabled) Indicates if the add-in manager is enabled.
void	setUserMode(boolean enabled) Indicates if the add-in manager is in user mode.
void	shutdown() Called to shutdown the addin manager (normally called at application shutdown).
void	translateID(String strID, GUID[] pID) Translates an AddIn string ID to it's corresponding registered GUID.

Method Detail

initialize

void initialize(Object pHook,
                String langID)
                throws IOException,
                       AutomationException

Called to initialize the addin manager (normally called at application startup).

Parameters:

pHook - A reference to another Object (IUnknown) (in)

langID - The langID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFolder

void addFolder(String pathToAddInFolder)
               throws IOException,
                      AutomationException

Adds a path to the folder processing list.

Parameters:

pathToAddInFolder - The pathToAddInFolder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFolder

void removeFolder(String pathToAddInFolder)
                  throws IOException,
                         AutomationException

Removes a path from the folder processing list.

Parameters:

pathToAddInFolder - The pathToAddInFolder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(String pathToAddInFolder)
             throws IOException,
                    AutomationException

Refreshes AddIns information in the specified folder.

Parameters:

pathToAddInFolder - The pathToAddInFolder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createObject

void createObject(GUID addInID,
                  Object pOuter,
                  Object[] ppObj)
                  throws IOException,
                         AutomationException

Create an instance of the specified object.

Parameters:

addInID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

pOuter - A reference to another Object (IUnknown) (in)

ppObj - A reference to another Object (IUnknown) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecord

IAddInRecord getRecord(GUID addInID)
                       throws IOException,
                              AutomationException

Returns the record asociated with the specified ID.

Parameters:

addInID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Returns:

A reference to a com.esri.arcgis.addinframework.IAddInRecord

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDsInCategory

void getIDsInCategory(GUID category,
                      IEnumAddInID[] ppEnumAddInIDs)
                      throws IOException,
                             AutomationException

Enumerate objects IDs within a specified category.

Parameters:

category - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppEnumAddInIDs - A reference to a com.esri.arcgis.addinframework.IEnumAddInID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

translateID

void translateID(String strID,
                 GUID[] pID)
                 throws IOException,
                        AutomationException

Translates an AddIn string ID to it's corresponding registered GUID.

Parameters:

strID - The strID (in)

pID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

void shutdown()
              throws IOException,
                     AutomationException

Called to shutdown the addin manager (normally called at application shutdown).

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddInRecords

IEnumNode getAddInRecords()
                          throws IOException,
                                 AutomationException

Retrieves all registered addin records.

Returns:

A reference to a com.esri.arcgis.addinframework.IEnumNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(int enabled)
                throws IOException,
                       AutomationException

Indicates if the add-in manager is enabled.

Parameters:

enabled - A com.esri.arcgis.addinframework.esriAddInMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnabled

int getEnabled()
               throws IOException,
                      AutomationException

Indicates if the addin manager is enabled.

Returns:

A com.esri.arcgis.addinframework.esriAddInMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddInFolders

IEnumAddInFolders getAddInFolders()
                                  throws IOException,
                                         AutomationException

Retrieves add-in probing folders.

Returns:

A reference to a com.esri.arcgis.addinframework.IEnumAddInFolders

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddInRecordsEx

IEnumNode getAddInRecordsEx(String xpathQuery)
                            throws IOException,
                                   AutomationException

Retrieves registered addin records matching the specified xpath query.

Parameters:

xpathQuery - The xpathQuery (in)

Returns:

A reference to a com.esri.arcgis.addinframework.IEnumNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserMode

void setUserMode(boolean enabled)
                 throws IOException,
                        AutomationException

Indicates if the add-in manager is in user mode.

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUserMode

boolean isUserMode()
                   throws IOException,
                          AutomationException

Indicates if the add-in manager is in user mode.

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocale

void getLocale(String[] locale)
               throws IOException,
                      AutomationException

Retrives the current locale.

Parameters:

locale - The locale (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initializeEx

void initializeEx(Object pHook,
                  String langID,
                  int options)
                  throws IOException,
                         AutomationException

Called to initialize the addin manager (normally called at application startup).

Parameters:

pHook - A reference to another Object (IUnknown) (in)

langID - The langID (in)

options - A com.esri.arcgis.addinframework.esriAddInSettings constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.