com.esri.arcgis.display
Interface IColorElements

All Superinterfaces:
Serializable
All Known Implementing Classes:
ColorElements

public interface IColorElements
extends Serializable

Provides access to the Color Elements Interface.

Description

This interface is new at ArcGIS 9.3.

Product Availability

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


Method Summary
 void add(IColor pColor)
          Add a color element.
 int getCount()
          The color elements count.
 IColor getElement(int index)
          The color element at the specified position.
 void insert(int index, IColor pColor)
          Add a color element at the specified posiiton.
 void remove(int index)
          Remove color element at the specified position.
 void removeAll()
          Remove all color elements.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The color elements count.

Product Availability

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

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

getElement

IColor getElement(int index)
                  throws IOException,
                         AutomationException
The color element at the specified position.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException
Remove color element at the specified position.

Product Availability

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

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Remove all color elements.

Product Availability

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

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

add

void add(IColor pColor)
         throws IOException,
                AutomationException
Add a color element.

Product Availability

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

Parameters:
pColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IColor pColor)
            throws IOException,
                   AutomationException
Add a color element at the specified posiiton.

Product Availability

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

Parameters:
index - The index (in)
pColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.