com.esri.arcgis.systemUI
Interface IPaletteDef

All Superinterfaces:
Serializable
All Known Implementing Classes:
ControlsInkEraserPalette, ControlsInkHighlightPalette, ControlsInkPenPalette

public interface IPaletteDef
extends Serializable

Provides access to members that define a ToolbarPalette.

When To Use

IPaletteDef is supported by the ToolbarPalette which can be hosted on a ToolbarControl, but this is not supported on ArcGIS Desktop application toolbars (ArcMap, ArcCatalog, ArcScene, ArcGlobe).

Product Availability

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


Method Summary
 String getCaption()
          The caption of this palette.
 int getItemCount()
          The number of items on this palette.
 void getItemInfo(int pos, IItemDef itemDef)
          The CLSID for the item on this palette at the specified index.
 String getName()
          The name of this palette.
 

Method Detail

getCaption

String getCaption()
                  throws IOException,
                         AutomationException
The caption of this palette.

Product Availability

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

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

getName

String getName()
               throws IOException,
                      AutomationException
The name of this palette.

Product Availability

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

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

getItemCount

int getItemCount()
                 throws IOException,
                        AutomationException
The number of items on this palette.

Product Availability

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

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

getItemInfo

void getItemInfo(int pos,
                 IItemDef itemDef)
                 throws IOException,
                        AutomationException
The CLSID for the item on this palette at the specified index.

Product Availability

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

Parameters:
pos - The pos (in)
itemDef - A reference to a com.esri.arcgis.systemUI.IItemDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.