com.esri.arcgis.controls
Interface ICustomizeDialog2

All Superinterfaces:

ICustomizeDialog, Serializable

All Known Implementing Classes:

CustomizeDialog

public interface ICustomizeDialog2
extends ICustomizeDialog, Serializable

Provides access to members that control the customize dialog.

Product Availability

Available with ArcGIS Engine.

Method Summary

String	getPalettesCategory() The GUID of the component category used for palette definitions.
void	setPalettesCategory(String pVal) The GUID of the component category used for palette definitions.
void	setWindowPosition(int left, int top) Positions the customize dialog at the given screen co-ordinates.

Methods inherited from interface com.esri.arcgis.controls.ICustomizeDialog

closeDialog, getCommandsCategory, getDialogTitle, getDoubleClickDestination, getMenusCategory, getToolbarsCategory, isDialogActive, isShowAddFromFile, setCommandsCategory, setDialogTitle, setDoubleClickDestination, setMenusCategory, setShowAddFromFile, setToolbarsCategory, startDialog

Method Detail

getPalettesCategory

String getPalettesCategory()
                           throws IOException,
                                  AutomationException

The GUID of the component category used for palette definitions.

Description

The guid of the component category used by the CustomizeDialog to read IPaletteDef objects. By default the PalettesCategory is set to the "ESRI Controls Palettes" category:

"{F278DFAD-3B0B-4708-99BF-227B113CB10B}"

Set the PalettesCategory to a valid guid of your own component category in order for the CustomizeDialog to pick up your own custom palettes rather than the default control palettes. The StartDialog method will extract all valid palettes 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.

setPalettesCategory

void setPalettesCategory(String pVal)
                         throws IOException,
                                AutomationException

The GUID of the component category used for palette 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.

setWindowPosition

void setWindowPosition(int left,
                       int top)
                       throws IOException,
                              AutomationException

Positions the customize dialog at the given screen co-ordinates.

Description

Sets the position the CustomizeDialog will display itself on the screen each time the ICustomizeDialog::StartDialog method is used. The position is in device co-ordinates (pixels) relative to the top left (0,0) of the screen display.

If a position is supplied that will take the CustomizeDialog off the screen display such as (-20,-20) the window will always display so it's visible. In this case at the top left with a position of (0,0).

Product Availability

Available with ArcGIS Engine.

Parameters:

left - The left (in)

top - The top (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.