com.esri.arcgis.controls
Interface ICustomizeDialog

All Superinterfaces:

Serializable

All Known Subinterfaces:

ICustomizeDialog2

All Known Implementing Classes:

CustomizeDialog

public interface ICustomizeDialog
extends Serializable

Provides access to members that control the customize dialog.

Superseded By

ICustomizeDialog2

Product Availability

Available with ArcGIS Engine.

Method Summary

void	closeDialog() Closes the customize dialog.
String	getCommandsCategory() The GUID of the component category used for commands.
String	getDialogTitle() The title of the customize dialog.
Object	getDoubleClickDestination() The ToolbarControl commands are added to when double clicked.
String	getMenusCategory() The GUID of the component category used for menu definitions.
String	getToolbarsCategory() The GUID of the component category used for toolbar definitions.
boolean	isDialogActive() Indicates if the customize dialog is active on the screen.
boolean	isShowAddFromFile() Indicates if the 'Add From File' button is available on the customize dialog.
void	setCommandsCategory(String pVal) The GUID of the component category used for commands.
void	setDialogTitle(String pVal) The title of the customize dialog.
void	setDoubleClickDestination(Object pToolbarControl) Sets the ToolbarControl commands are added to when double clicked.
void	setMenusCategory(String pVal) The GUID of the component category used for menu definitions.
void	setShowAddFromFile(boolean pVal) Indicates if the 'Add From File' button is available on the customize dialog.
void	setToolbarsCategory(String pVal) The GUID of the component category used for toolbar definitions.
void	startDialog(int hWndParent) Starts the modeless customize dialog.

Method Detail

startDialog

void startDialog(int hWndParent)
                 throws IOException,
                        AutomationException

Starts the modeless customize dialog.

Description

Opens a modeless CustomizeDialog on the screen and fires the ICustomizeDialogEvents::OnStartDialog event. The CustomizeDialog allows users to add commands, menus, palettes and toolsets onto the ToolbarControl by ether dragging and dropping or double clicking them.

The CustomizeDialog can be closed through user interaction, calling the CloseDialog method, or when the CustomizeDialog object is released.

Product Availability

Available with ArcGIS Engine.

Parameters:

hWndParent - The hWndParent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCommandsCategory

String getCommandsCategory()
                           throws IOException,
                                  AutomationException

The GUID of the component category used for commands.

Description

The guid of the component category used by the CustomizeDialog to read ICommand objects. By default the CommandsCategory is set to the "ESRI Controls Commands" category:

"{B284D891-22EE-4F12-A0A9-B1DDED9197F4}"

Set the CommandsCategory to a valid guid of your own component category in order for the CustomizeDialog to pick up your own custom commands rather than the default control commands. The StartDialog method will extract all valid commands from this component category.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCommandsCategory

void setCommandsCategory(String pVal)
                         throws IOException,
                                AutomationException

The GUID of the component category used for commands.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolbarsCategory

String getToolbarsCategory()
                           throws IOException,
                                  AutomationException

The GUID of the component category used for toolbar definitions.

Description

The guid of the component category used by the CustomizeDialog to read IToolbarDef objects. By default the ToolbarsCategory is set to the "ESRI Controls Toolbars" category:

"{5155BBC7-A6E9-4AF9-81DB-A16742D5A026}"

Set the ToolbarsCategory to a valid guid of your own component category in order for the CustomizeDialog to pick up your own custom toolsets rather than the default control toolsets. The StartDialog method will extract all valid toolsets from this component category.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToolbarsCategory

void setToolbarsCategory(String pVal)
                         throws IOException,
                                AutomationException

The GUID of the component category used for toolbar definitions.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDialog

void closeDialog()
                 throws IOException,
                        AutomationException

Closes the customize dialog.

Description

Closes the CustomizeDialog if it is active on the screen and fires the ICustomizeDialogEvents::OnCloseDialog event.

Product Availability

Available with ArcGIS Engine.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDialogActive

boolean isDialogActive()
                       throws IOException,
                              AutomationException

Indicates if the customize dialog is active on the screen.

Description

Indicates whether the modeless CustomizeDialog is currently on the screen. The CustomizeDialog can be closed through user interaction, calling the CloseDialog method, or when the CustomizeDialog object is released.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDialogTitle

String getDialogTitle()
                      throws IOException,
                             AutomationException

The title of the customize dialog.

Description

The title displayed in the CustomizeDialog window.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDialogTitle

void setDialogTitle(String pVal)
                    throws IOException,
                           AutomationException

The title of the customize dialog.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDoubleClickDestination

Object getDoubleClickDestination()
                                 throws IOException,
                                        AutomationException

The ToolbarControl commands are added to when double clicked.

Description

The ToolbarControl passed to the SetDoubleClickDestination method that new items will be added to when an ICommand, IMenuDef, IPaletteDef or IToolbarDef object is double clicked upon in the CustomizeDialog window.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDoubleClickDestination

void setDoubleClickDestination(Object pToolbarControl)
                               throws IOException,
                                      AutomationException

Sets the ToolbarControl commands are added to when double clicked.

Description

Determines the ToolbarControl that new items will be added to when an ICommand, IMenuDef, IPaletteDef or IToolbarDef object is double clicked upon in the CustomizeDialog.

Product Availability

Available with ArcGIS Engine.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowAddFromFile

boolean isShowAddFromFile()
                          throws IOException,
                                 AutomationException

Indicates if the 'Add From File' button is available on the customize dialog.

Description

Determines whether the CustomizeDialog has an 'Add From File..' button. Clicking this button enables users to browse and select *.dll and *.tlb files containing objects that implement ICommand, IMenuDef, IPaletteDef and IToolbarDef. The selected *.dll or *.tlb will be registered and the objects registered in the appropriate CommandsCategory, MenusCategory, PalettesCategory and ToolbarsCategory component categories. This property is true by default.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowAddFromFile

void setShowAddFromFile(boolean pVal)
                        throws IOException,
                               AutomationException

Indicates if the 'Add From File' button is available on the customize dialog.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMenusCategory

String getMenusCategory()
                        throws IOException,
                               AutomationException

The GUID of the component category used for menu definitions.

Description

The guid of the component category used by the CustomizeDialog to read IMenuDef objects. By default the MenusCategory is set to the "ESRI Controls Menus" category:

"{B7D74382-06A8-483F-8FE5-6FB08FAA356A}"

Set the MenusCategory to a valid guid of your own component category in order for the CustomizeDialog to pick up your own custom menus rather than the default control menus. The StartDialog method will extract all valid menus from this component category.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMenusCategory

void setMenusCategory(String pVal)
                      throws IOException,
                             AutomationException

The GUID of the component category used for menu definitions.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.